Improve function docs for Repository::tag_foreach#1190
Merged
Conversation
ehuss
approved these changes
Oct 20, 2025
Contributor
ehuss
left a comment
There was a problem hiding this comment.
Thanks!
I notice that it is a little unfortunate that this doesn't do any error handling. Though I suppose an error would probably only happen with a corrupt repo or other catastrophic situation. A callback that panics will also silently drop the panic and just stop iteration.
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
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.
Previously the documentation did not make it clear the effect of the return value of
cb. This PR clarifies that, alongside a minor rewording of existing docs.Ref:
https://libgit2.org/docs/reference/main/tag/git_tag_foreach_cb.html
git2-rs/src/tagforeach.rs
Lines 18 to 43 in 1d9f4d4