Expand traverse and descendants documentation: Issue #369 #375
Conversation
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
original traverse documentation is a shortened version of descendants documentation. Edited documentation comments to clarify the following: 1. traverse and reverse_traverse return an iterator of `NodeEdge` objects. `NodeEdge` objects mark start (similar to `<div>`) and end (similar to `</div>`) of each node. 2. descendants returns an iterator of `Node` objects. This is probably more useful if you want to play with the Node contents. 3. added a short "Similar Functions" section to the inline documentation to point users in the right direction.
kivikakk
approved these changes
Apr 16, 2024
Owner
|
Thank you! |
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.
original traverse documentation is a shortened version of descendants
documentation. Edited documentation comments to clarify the following:
traverse and reverse_traverse return an iterator of
NodeEdgeobjects.
NodeEdgeobjects mark start (similar to<div>) and end(similar to
</div>) of each node.descendants returns an iterator of
Nodeobjects. This is probablymore useful if you want to play with the Node contents.
added a short "Similar Functions" section to the inline documentation
to point users in the right direction.
Improves on issue #369