docs: fix six @param names that do not match the signatures - #7341
Merged
ethomson merged 1 commit intoAug 15, 2026
Merged
Conversation
- refdb_backend: the iterator callback documents `out` for an argument named `iter`; unlock documents `who`, which is the name `rename` uses, while unlock itself takes `sig` - utf-conv: git_utf8_from_16 documents `src_len`, an argument only git_utf8_from_16_with_len has - path_w32: both trim_end and remove_namespace document `path` for an argument named `str` - w32_util: filetime_to_timespec documents `FILETIME`, the type, where the argument is `ft` Comments only.
Member
|
Thanks! |
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.
six
@paramnames that no function of that name takessys/refdb_backend.h— the iterator callback documentsout, the argument isiter. unlock documentswho, which is whatrenamecalls its signature argument; unlock itself takessigutf-conv.h— git_utf8_from_16 documentssrc_len, an argument only git_utf8_from_16_with_len has. looks like the block was copied from its longer siblingpath_w32.h— both trim_end and remove_namespace documentpathwhile the argument isstrw32_util.h— filetime_to_timespec documentsFILETIME, which is the type, not the name. argument isftcomments only, nothing else touched
by the way path_w32 also leaves the second argument
lenundocumented in both, I left that alone to keep the diff to one thingfound with a checker I wrote that reads
@paramnames against the declaration below them, each of these read by hand