Improve docs for PushUpdate, push_negotiation, plus a bit more #1044
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
I took some of the phrasing from https://libgit2.org/libgit2/#HEAD/type/git_push_update Before looking at the code, I didn't realize that the functions returning `None` means the reference name is not UTF-8, as opposed to the reference not existing.
ilyagr
changed the title
This was motivated by the observations that: - The [`PushNegotiation` docstring] was previously much more informative than the docstring for `push_negotiation`. - The `PushNegotiation` docstring does not seem to be accessible via https://docs.rs/git2/0.18.3/git2/index.html. Only the less helpful docstring is accessible at https://docs.rs/git2/0.18.3/git2/struct.RemoteCallbacks.html#method.push_negotiation. [`PushNegotiation` docstring]: rust-lang@920c838#diff-ccd8cf48c67bd6cc71379f93a6b51abdb10954497a0db353908a7cf20995ef61R92-R99
ehuss
approved these changes
Apr 15, 2024
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.
For PushUpdate, I took some of the phrasing from
https://libgit2.org/libgit2/#HEAD/type/git_push_update
Before looking at the code, I didn't realize that the functions returning
Nonemeans the reference name is not UTF-8, as opposed to the reference not existing.(I wish the return value for
..._refnamefunctions would just beResult<&str, UTFDecodeError>, but that would be a breaking change.)For PushNegotiation and push_negotiation, only the latter has docs accessible via docs.rs, but its docstring was less helpful. See also the commit description.