Sync function docstrings with their signatures#3329
Merged
BenjaminBossan merged 1 commit intoJun 29, 2026
Conversation
c1f6ba5 to
1b794b9
Compare
Contributor
Author
|
Gentle ping on this one, @BenjaminBossan. It's the function-docstring/signature half of the same audit as #3319 and #3328 (both merged), covering |
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
BenjaminBossan
approved these changes
Jun 29, 2026
BenjaminBossan
left a comment
Member
There was a problem hiding this comment.
Thanks for fixing the docstrings, LGTM.
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.
What does this PR do?
Fixes function docstrings that drifted from their actual signatures (no functional changes).
1. Wrong parameter name (
adapter_name→adapter_names).set_requires_grad(inAuxiliaryTrainingWrapper,BaseTuner,BaseTunerLayer,PeftModel, and the module-level helper) andBaseTunerLayer.set_adapterall take a parameter namedadapter_names(plural), but theirArgs:sections documentedadapter_name. Following the docs (set_requires_grad(adapter_name=...)) raisesTypeError. Renamed the docstring entry to match the signature.2. Spurious
Args: modelon delegating methods.PeftModel.get_layer_status(self)andPeftModel.get_model_status(self)take nomodelargument — they delegate to the module-levelget_layer_status(model)/get_model_status(model)functions. Their docstrings had anArgs: model (...)block (copied from those functions) describing a parameter the methods don't accept. Removed it from the two methods; the module-level functions (which do takemodel) keep theirArgsunchanged.Before submitting