Wrote up a couple examples for docstrings#712
Merged
Conversation
| `thomas-cokelaer.info`_ has a fairly complete article showing more examples for | ||
| this style. | ||
|
|
||
| While the end result is parsed by Sphinx and renders correctly in a browser, it |
Contributor
There was a problem hiding this comment.
Let's get rid of this paragraph. I'm not a fan of that first-line indent style, and I think it would be best not to show it altogether.
Contributor
|
This is great! I left a short note. Other than that, ready to merge! |
Contributor
Author
|
@kennethreitz, would it be better to remove the first example ( So remove lines 205-223 of commit 4fb3bf7 and then reword lines 201-203 and 225-227 accordingly, like in to 3c0b027? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I added some words about commonly used patterns, as well as touching on what sphinx does and how it turns your code into documentation automatically. Also added a couple links to useful articles if people want to read further. Relevant to #678 and #699