Improve docs and xrefs re tree building #726
Merged
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
src/build.rs
Outdated
| /// Paths passed to `remove` and `upsert` can be multi-component paths, ie they | ||
| /// may contain slashes. | ||
| /// | ||
| /// This is the more-cooked tree update facility. There is also [`TreeBuilder`] |
There was a problem hiding this comment.
Suggested change
| /// This is the more-cooked tree update facility. There is also [`TreeBuilder`] | |
| /// This is a higher-level tree update facility. There is also [`TreeBuilder`] |
(Parallel construction with "lower-level".)
|
I posted one very minor wording tweak, but otherwise this seems reasonable. Would you consider adding coverage of the main limitation of the high-level API as well? Quoting the libgit2 documentation:
|
It seems obvious from the rest of the docs what to do with a `TreeUpdateBuilder`. The reference to `git_tree_create_updated` is certainloy not helpful since that's a C function. Signed-off-by: Ian Jackson <[email protected]>
Signed-off-by: Ian Jackson <[email protected]>
ehuss
approved these changes
Apr 1, 2023
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 had to discover some of the facts here empirically so I thought I would write them up for other folks :-).