Skip to content

unittest things to be doc'd #35113

Closed
Closed

Description

@rsalz
mannequin
BPO 458771
Nosy @freddrake

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/freddrake'
closed_at = <Date 2001-09-06.19:11:15.000>
created_at = <Date 2001-09-05.15:49:41.000>
labels = ['docs']
title = "unittest things to be doc'd"
updated_at = <Date 2001-09-06.19:11:15.000>
user = 'https://bugs.python.org/rsalz'

bugs.python.org fields:

activity = <Date 2001-09-06.19:11:15.000>
actor = 'fdrake'
assignee = 'fdrake'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2001-09-05.15:49:41.000>
creator = 'rsalz'
dependencies = []
files = []
hgrepos = []
issue_num = 458771
keywords = []
message_count = 4.0
messages = ['6364', '6365', '6366', '6367']
nosy_count = 2.0
nosy_names = ['fdrake', 'rsalz']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue458771'
versions = []

Activity

  1. rsalz commented on Sep 5, 2001

    rsalzmannequin
    MannequinAuthor

    We're starting to use the unittest module, and am
    noticing some things that need documentation or doc
    fixes.

    TestSuite class: the run() method requires the result
    object; unlike TestCase, it's not optional.

    TestSuite objects "prefer" to be invoked by a test
    runner (according to comments in the source); the run()
    method of the TextTestRunner should be documented. If
    not, then TestSuite.__call__ needs to be changed to
    make the result object optional.

    I don't think the docs explain using the first line of
    the docstring as the "short description" for tests.

    TestLoader.loadTestFromName needs to define what a
    "string specifier" is, as dis ltnNames. :)

  2. added
    docsDocumentation in the Doc dir
    on Sep 5, 2001
  3. added
    docsDocumentation in the Doc dir
    on Sep 5, 2001
  4. freddrake commented on Sep 6, 2001

    @freddrake
    Member

    Logged In: YES
    user_id=3066

    The use of the docstring as a source for the short
    description is explained in the docs for
    TestCase.shortDescription().

    I think I've addressed your other comments in
    Doc/lib/libunittest.tex revision 1.6.

  5. rsalz commented on Sep 6, 2001

    rsalzmannequin
    MannequinAuthor

    Logged In: YES
    user_id=36737

    Looks good, except now you need to document makeSuite, in
    particular that the 2nd string argument means "all functions
    that start with this prefix are tests" :)

  6. freddrake commented on Sep 6, 2001

    @freddrake
    Member

    Logged In: YES
    user_id=3066

    makeSuite() should not be documented; it was marked obsolete
    in the PyUnit sourcecode before it was accepted into the
    standard library.

  7. transferred this issue fromon Apr 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dir

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions