Fix docstrings naming parameters that are not in the signature - #1003
Conversation
- symmetric_difference/_update take one `other`, not varargs `others` - both `append` methods take `val`, not `node` - _parse_fancy_name had a duplicated, transposed `idenitifer` entry - Surface.update_pointers takes `data_inputs`, not `data_cards` Fixes idaholab#1002
MicahGale
left a comment
There was a problem hiding this comment.
The changes look good for the most part. Though, @karpovantonme why did you remove your disclosure of using Claude code?
|
Sorry — that was carelessness with the form on my part, not an attempt to hide anything. I changed the first box to say I'm a human, since I am the one submitting this and standing behind it, and flipped the second one in the same edit without thinking it through. I've put it back. To be explicit: yes, Claude Code was used. It ran the sweep that compares every numpydoc |
|
The changelog test failure can be ignored in this case. |
MicahGale
left a comment
There was a problem hiding this comment.
Looks good. I agree we can ignore the changelog requirement. Thanks @karpovantonme!
Description
Fixes #1002.
Four docstrings name a parameter the function does not take. Details and the reasoning for each are in the issue; in short:
symmetric_difference/symmetric_difference_updatedocumentothers(plural, "the other collections") but take a singleother— the text was copied fromdifference(*others)above, which really is varargs.PaddingNode.appendandListNode.appenddocumentnode; both signatures areappend(self, val, ...).Nuclide._parse_fancy_namehas two Parameters entries for one argument: a bareidentifier, thenidenitiferwith the letters transposed.Surface.update_pointersdocumentsdata_cards; the signature isdata_inputs, andMaterial.update_pointersandThermalScatteringLaw.update_pointersalready document it that way.Docstrings only — no code, no behaviour change, so there is nothing for a test to assert. Say the word if you would rather have it covered some other way.
General Checklist
blackversion 25 or 26.LLM Disclosure
Are you?
Were any large language models (LLM or "AI") used in to generate any of this code?
The four were found by comparing every NumPy-style
Parametersblock in the package against the actual signature, then reading each hit to rule out decorators,**kwargsand the property-setter documentation style used infill.pyandimportance.py(those two are deliberate and were left alone).Documentation Checklist
.. versionchanged::or.. versionadded::directives — not applicable, no API change.📚 Documentation preview 📚: https://montepy--1003.org.readthedocs.build/en/1003/
📚 Documentation preview 📚: https://montepy--1003.org.readthedocs.build/en/1003/