Add documentation for tweepy.parsers
#723
Open
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
5tefan
reviewed
Nov 17, 2016
|
Did you mean it's documenting improvements that aren't in the code or that it's an improvement in the documentation? |
Harmon758
requested changes
Jun 7, 2019
There was a problem hiding this comment.
This should be in a new parsers.rst file rather than part of the documentation for API.
Also, the descriptions are a little verbose and should probably be simplified to describe a user's perspective of the functionality for each parser rather than outlining all the internal logic.
|
|
||
| Abstract method to be implemented by inheriting classes. Throws a ``NotImplementedError`` when not overriden. | ||
|
|
||
| .. method:: Parser.parse(payload) |
There was a problem hiding this comment.
Suggested change
| .. method:: Parser.parse(payload) | |
| .. method:: Parser.parse_error(payload) |
|
|
||
| Bases: :class:`Parser` | ||
|
|
||
| An implementation of :class:`Parser`` used for parsing :class:`JSON` payloads. It tries to import the :class:`simplejson` library. If it fails, it imports the :class:`json` library. If that fails as well, it will try to import the :class:`simplejson` library from ``django.utils``. If that fails too, an :exc:`ImportError` is thrown. |
There was a problem hiding this comment.
This description needs to be updated as simplejson isn't used anymore.
Harmon758
added
Need Follow-Up
Harmon758
force-pushed
the
master
branch
5 times, most recently
from
cf54e31
to
d538993
Compare
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.
I added some documentation for
tweepy.parsers. Would appreciate it if someone reviewed what I wrote to see if it's correct and whether or not it'll render properly.