doc(reference): Standardize docstring syntax #427
Merged
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
| by implementing non-blocking behavior for the cases mentioned | ||
| above. | ||
|
|
||
| Args: | ||
| stream: Instance of socket._fileobject from environ['wsgi.input'] | ||
| stream: Instance of ``socket._fileobject`` from ``environ['wsgi.input']`` |
|
Just realized that after seeing the pep8 failures you likely could've identified the lines locally. Sorry for the spam! |
|
@rsyed83 no worries, thanks for the review! |
Unify the use of markup in docstrings, particulary relating to the use of backticks and asterisks. Also clean up any remaining minor inconsistencies or errors in the docstrings. Closes falconry#334
kgriffs
added a commit
that referenced
this pull request
Feb 4, 2015
doc(reference): Standardize docstring syntax
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.
Unify the use of markup in docstrings, particulary relating to the use of
backticks and asterisks. Also clean up any remaining minor inconsistencies or
errors in the docstrings.
Closes #334