Make constants constant, fix broken ref in docs #59
Conversation
| :mod:`fauxfactory.constants` | ||
| ---------------------------- | ||
|
|
||
| .. automodule:: fauxfactory.constants |
There was a problem hiding this comment.
The :members: argument does not need to be specified, because there are no functions or classes in this module.
There was a problem hiding this comment.
Are you going to remove it then?
There was a problem hiding this comment.
@omaciel, say again? I don't understand. The :members: argument is not present.
There was a problem hiding this comment.
Guess I don't understand your initial comment... I see a :members: entry on line 10 and you said that it doesn't have to be present...
There was a problem hiding this comment.
Aha! :members: does not need to be an argument to line 15, as fauxfactory.constants contains no functions or classes. :members: should be present on line 10, as fauxfactory does contain functions and/or classes.
Use tuples instead of lists in module `fauxfactory.constants`. The built-in
tests function correctly:
$ make test
python -m unittest discover --start-directory tests --top-level-directory .
.................................................................................................................................................................
----------------------------------------------------------------------
Ran 161 tests in 0.934s
OK
Make some changes to documentation:
* Drop some comments from `fauxfactory.constants`. An explanation of lorem ipsum
seems unnecessary, for example.
* Move remaining descriptions in to the module-wide docstring. This allows
descriptions to be found both by Sphinx and the `help` built-in. Also include
the `fauxfactory.constants` module in the API documentation. These changes
allow documentation to be built with zero warnings.
|
ACK |
Make constants constant, fix broken ref in docs
Use tuples instead of lists in module
fauxfactory.constants. The built-intests function correctly:
Make some changes to documentation:
fauxfactory.constants. An explanation of lorem ipsumseems unnecessary, for example.
descriptions to be found both by Sphinx and the
helpbuilt-in. Also includethe
fauxfactory.constantsmodule in the API documentation. These changesallow documentation to be built with zero warnings.