Improve the xee-xpath::Documents docs #130
Merged
faassen merged 5 commits intoPaligo:mainfrom Jan 5, 2026
Merged
Conversation
added 5 commits
November 7, 2025 12:12
…nt more accesible from xee-xpath::documents::Documents
…_interpreter::xml::Document and Xot. This should make a bit clearer the overall picture and how Xot and xee-path relate, and the usefulness of the xee-xpath::Documents collection and its underlaying xee_interpreter::xml::Document, which has a bunch of useful methods.
faassen
approved these changes
Jan 5, 2026
Open
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
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.
When exploring xee-xpath after using a bit Xot it was not clear to me how they were related and this tries to help other new users, trying to make clearer how the Documents struct relates to the underlaying xee-interpreter::xml::Documents and Document structs, which have useful methods and how they fit with Xot.
I wonder if having in Xot itself a Documents struct that can be later used (or reexported) by xee-xpath would be better, as it looks like a higher level utility for general XML handling while xee-xpath looks like more like an specialized helper. In fact, I have been using Xot and making my own bag of Xot arena + root nodes collection until I needed xpath and found Documents was exactly what I was looking for.
I would expect other new users to start with Xot and grow from there their knowledge of the related crates.