Skip to content

docs: fix six @param names that do not match the signatures - #7341

Merged
ethomson merged 1 commit into
libgit2:mainfrom
karpovantonme:docs/param-names-match-signatures
Aug 15, 2026
Merged

docs: fix six @param names that do not match the signatures#7341
ethomson merged 1 commit into
libgit2:mainfrom
karpovantonme:docs/param-names-match-signatures

Conversation

@karpovantonme

Copy link
Copy Markdown
Contributor

six @param names that no function of that name takes

  • sys/refdb_backend.h — the iterator callback documents out, the argument is iter. unlock documents who, which is what rename calls its signature argument; unlock itself takes sig
  • utf-conv.h — git_utf8_from_16 documents src_len, an argument only git_utf8_from_16_with_len has. looks like the block was copied from its longer sibling
  • path_w32.h — both trim_end and remove_namespace document path while the argument is str
  • w32_util.h — filetime_to_timespec documents FILETIME, which is the type, not the name. argument is ft

comments only, nothing else touched

by the way path_w32 also leaves the second argument len undocumented in both, I left that alone to keep the diff to one thing

found with a checker I wrote that reads @param names against the declaration below them, each of these read by hand

- 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.
@ethomson

Copy link
Copy Markdown
Member

Thanks!

@ethomson
ethomson merged commit 0334930 into libgit2:main Aug 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants