Fix incorrect parameter names in docstrings#5412
Conversation
Several docstrings documented parameter names that don't match their signatures: - util.which documented 'programe' (typo) instead of 'program'. - TransformationsBase.add_transformations (FrameIteratorBase and MemoryReader) documented 'transform_list' instead of 'transformations'. - GuesserBase.is_guessable documented 'guess' instead of 'attr_to_guess'.
The same add_transformations docstring fix remains in coordinates/memory.py; base.py is left untouched to avoid a large unrelated reformatting diff.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #5412 +/- ##
========================================
Coverage 93.85% 93.85%
========================================
Files 182 182
Lines 22509 22509
Branches 3202 3202
========================================
Hits 21125 21125
Misses 922 922
Partials 462 462 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
IAlibay
left a comment
There was a problem hiding this comment.
Thanks for opening this PR @eeshsaxena - however, before we do any rerview, we ask you to fill in the AI declaration section that was in the original PR template.
|
Thanks @IAlibay, apologies for missing that - I've filled in the LLM/AI disclosure section now. I also trimmed the PR to leave out |
|
Quick note on the red |
Fix incorrect parameter names in docstrings
Changes made in this Pull Request:
Several docstrings document parameter names that do not match their function signatures:
MDAnalysis.lib.util.whichdocumentsprograme(typo) instead ofprogram.MemoryReader.add_transformations(coordinates/memory.py) documentstransform_listinstead of the actual*transformationsparameter.MDAnalysis.guesser.base.GuesserBase.is_guessabledocumentsguessinstead of itsattr_to_guessparameter (the siblingguess_attralready documents it correctly).Documentation-only change; no behaviour is affected.
(Note:
coordinates/base.pyhas the sameadd_transformationsdocstring issue, but it was left out of this PR because that file is not yet black-formatted and including it tripped the black CI on pre-existing, unrelated lines. Happy to do it in a separate PR if you would like.)LLM / AI generated code disclosure
LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution: yes
Partial. An AI assistant was used to help identify the docstring/signature mismatches (via a script comparing documented parameters against function signatures) and to draft wording. Every change was manually reviewed and verified against the actual function signatures.
PR Checklist