html5parser documentation pass #374
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
|
This documents the html5parser module for #307. |
Codecov Report
@@ Coverage Diff @@
## master #374 +/- ##
==========================================
- Coverage 90.76% 90.75% -0.02%
==========================================
Files 50 50
Lines 6950 6942 -8
Branches 1328 1328
==========================================
- Hits 6308 6300 -8
Misses 483 483
Partials 159 159
Continue to review full report at Codecov.
|
|
@gsnedders, @jgraham Can either of you review this? |
hugovk
approved these changes
Nov 30, 2017
html5lib/html5parser.py
Outdated
| @@ -219,32 +267,52 @@ def normalizedTokens(self): | |||
| def parse(self, stream, *args, **kwargs): | |||
| """Parse a HTML document into a well-formed tree | |||
|
|
|||
| stream - a filelike object or string containing the HTML to be parsed | |||
| :arg stream: a filelike object or string containing the HTML to be parsed | |||
There was a problem hiding this comment.
"filelike" -> "file-like" (plus three others below)
html5lib/html5parser.py
Outdated
| regardless of any BOM or later declaration (such as in a meta | ||
| element). | ||
|
|
||
| :arg scripting: treat noscript elements as if javascript was turned on |
There was a problem hiding this comment.
"javascript" -> "JavaScript" (plus below)
gsnedders
previously approved these changes
Nov 30, 2017
|
Can you squash the commit addressing review comments? |
The public API should all be documented. Anything that isn't documented with a docstring or starts with a _ isn't part of the public API. Given that, we shouldn't be autodoc'ing undocumented members. We do want to document __init__ since that's how the classes get built. So we explicitly add that to autodoc. I think this is a good base to build on. If it isn't, we can adjust things and maybe explicitly specify what should and shouldn't be documented.
|
^^^ That squashes the last two commits. |
|
@gsnedders Can you update the review for this, please? |
gsnedders
approved these changes
Dec 3, 2017
|
Thank you! |
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.
This fixes some issues in building documentation in general and adjusts the autodoc settings to generate docs for the supported public API.
This improves the documentation of the html5parser module.
Are there other things in the html5parser module that should be part of the public API? Are there better examples to include?