Ticket #3501 enhancement closed wontfix
Fix use of * in epytext markup
| Reported by: | thijs | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | core | Keywords: | documentation |
| Cc: | Branch: | ||
| Author: | Launchpad Bug: |
Description
For some reason some of the epytext in the codebase is using asterisks, like:
@param *args: description
but this isn't valid epytext, if you run epydoc on these files it will throw errors like:
+-------------------------------------------------------------------------------------------------------------------------------------------- | File /trunk/twisted/trial/reporter.py, line 399, in twisted.trial.reporter.Reporter._writeln | Warning: @param for unknown parameter "*args"
Changing this to the following fixes the error and renders the correct docs (at least with epydoc):
@param args: description
Here's a list of broken epytext which should be fixed:
$ grep -E '@param \*' twisted/ -r --include '*.py'
twisted/enterprise/adbapi.py: @param *args: positional arguments to be passed to func
twisted/enterprise/adbapi.py: @param **kw: keyword arguments to be passed to func
twisted/enterprise/adbapi.py: @param *args: additional positional arguments to be passed
twisted/enterprise/adbapi.py: @param **kw: keyword arguments to be passed to interaction
twisted/internet/base.py: @param *args: Positional arguments to pass to C{callable}.
twisted/internet/base.py: @param **kwargs: Keyword arguments to pass to C{callable}.
twisted/internet/task.py: @param *args: The positional arguments to pass to C{callable}.
twisted/internet/task.py: @param **kw: The keyword arguments to pass to C{callable}.
twisted/internet/threads.py: @param *args: positional arguments to pass to f.
twisted/internet/threads.py: @param **kwargs: keyword arguments to pass to f.
twisted/internet/threads.py: @param *args: positional arguments to pass to f.
twisted/internet/threads.py: @param **kwargs: keyword arguments to pass to f.
twisted/mail/imap4.py: @param *names: The status names to query. These may be any number of:
twisted/names/client.py: @param *args: Positional arguments to be passed to
twisted/python/threadpool.py: @param *args: positional arguments to be passed to func
twisted/python/threadpool.py: @param **kw: keyword args to be passed to func
twisted/python/threadpool.py: @param *args: positional arguments to be passed to func
twisted/python/threadpool.py: @param **kwargs: keyword arguments to be passed to func
twisted/python/util.py: @param *args: arguments passed to C{function}
twisted/python/util.py: @param **kwargs: keyword arguments passed to C{function}
twisted/spread/ui/tkutil.py: @param **kw: see L{SimpleDialog} class
twisted/test/test_stdio.py: @param *args: strings which will be passed to the child process on
twisted/test/test_stdio.py: @param **kw: additional arguments to pass to L{reactor.spawnProcess}.
twisted/trial/reporter.py: @param *args: The arguments for the format string.
twisted/trial/reporter.py: @param *args: The arguments for the format string.
twisted/trial/unittest.py: @param *errorTypes: If unspecifed, flush all errors. Otherwise, only
twisted/web/test/test_httpauth.py: @param **kw: Keywords and C{str} values which will be treated as field
Change History
Note: See
TracTickets for help on using
tickets.
