Polish documentation #45
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
Fix a typo in the readme. Fix errors in the API documentation. Remove all references to `obj` and `object`. An "obj" cannot be instantiated, telling the user that an "object" is returned is nearly useless (what _isn't_ an object?), and neither is listed in `nitpick_ignore` in `docs/conf.py`. Also: Add a link to RFC 3629, drop some spurious backslashes and better wrap a line.
|
Agreed with comment (I wanted to ask you about suggestions for replacing |
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.
Fix a typo in the readme.
Fix errors in the API documentation. Remove all references to
objandobject. An "obj" cannot be instantiated, telling the user that an "object" isreturned is nearly useless (what isn't an object?), and neither is listed in
nitpick_ignoreindocs/conf.py. Also: Add a link to RFC 3629, drop somespurious backslashes and better wrap a line.