docstring: Add decorator to format the docstrings #33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for this. Apologies for the delay. Looks good. I am wondering whether formatting the docs should be the default behaviour, and we could do without the need for an extra decorator. What do you think? |
|
I think it is a good idea to make it the default behaviour. I'll try to find some time and adapt the patch this week. |
Some test frameworks like nose use the docstring to output information about a test. In the case of generated tests all of them would get the same description. Format of the docstring for each generated test function using the test values. Example: @DaTa(1,2) def test_A(value): """Test A for value {}""" ... executed with "nosetests -v", will output: Test A for value 1 Test A for value 2 Signed-off-by: [email protected]
txels
added a commit
that referenced
this pull request
Aug 11, 2015
docstring: Add decorator to format the docstrings
|
Thanks! |
|
Thank you too. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some test frameworks like nose use the docstring to output information
about a test. In the case of generated tests all of them would get the
same description. Format the docstring for each generated test function using the test values.
Example:
@DaTa(1,2)
def test_A(value):
"""Test A for value {}"""
...
executed with "nosetests -v", will output:
Test A for value 1
Test A for value 2
Signed-off-by: [email protected]