Auto-generate API documentation. Refactor code. #40
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
| @@ -10,9 +10,7 @@ Getting Started | |||
| sys.path.append(ROOT_PATH) | |||
| from fauxfactory import FauxFactory | |||
|
|
|||
| FauxFactory generates random data for your automated tests easily! | |||
There was a problem hiding this comment.
Already stated in introduction.
|
Not all docstrings have been reworked. Only the docstrings for three (?) functions and methods have been reworked. |
Generate API documentation directly from docstrings. Re-write several docstrings to be clearer and use Sphinx directives. Refactor the logic behind `codify` and `FauxFactory.generate_string`.
| else: | ||
| raise Exception("%s is not a supported string type." % str_type) | ||
| method = getattr(cls, 'generate_{}'.format(str_type_lower)) |
|
ACK |
omaciel
added a commit
that referenced
this pull request
Sep 18, 2014
Auto-generate API documentation. Refactor code.
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.
Generate API documentation directly from docstrings. Re-write several docstrings
to be clearer and use Sphinx directives.
Refactor the logic behind
codifyandFauxFactory.generate_string.