Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand traverse and descendants documentation: Issue #369 #375

Merged
merged 3 commits into from
Apr 16, 2024

Conversation

kaesluder
Copy link
Contributor

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.

Improves on issue #369

kaesluder and others added 3 commits April 13, 2024 21:29
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
Copy link
Owner

Thank you!

@kivikakk kivikakk merged commit 666486f into kivikakk:main Apr 16, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants