fixed multiple typos in python files#5263
fixed multiple typos in python files#5263jyothiswaroopch wants to merge 1 commit intoMDAnalysis:developfrom
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello there first time contributor! Welcome to the MDAnalysis community! We ask that all contributors abide by our Code of Conduct and that first time contributors introduce themselves on GitHub Discussions so we can get to know you. You can learn more about participating here. Please also add yourself to package/AUTHORS as part of this PR.
There was a problem hiding this comment.
Pull request overview
This PR fixes multiple spelling/typographical errors across Python source files in the MDAnalysis package. All corrections are in comments and docstrings — no logic is changed.
Changes:
- Corrected common misspellings:
analyis→analysis,accomodate→accommodate,overriden→overridden,occurence(s)→occurrence(s),dependant→dependent,coordiante(s)→coordinates,indeces→indices, and doubled-word errors (the the→the). - One change in
tables.pyrenames the docstring reference from*convertor*to*converter*, but the actual function parameter remainsconvertor, creating a docstring/signature mismatch.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
visualization/streamlines_3D.py |
analyis → analysis in module docstring |
visualization/streamlines.py |
analyis → analysis in module docstring |
topology/PSFParser.py |
accomodate → accommodate in inline comment |
topology/PDBParser.py |
indicies → indices in inline comment |
topology/ITPParser.py |
the the → the in docstring |
lib/distances.py |
coordiantes → coordinates in two docstrings |
lib/correlations.py |
dependant → dependent in docstring |
guesser/tables.py |
convertor → converter in docstring (mismatches actual parameter name) |
core/topologyattrs.py |
overriden → overridden (×3), dependant → dependent in docstrings |
core/groups.py |
occurences → occurrences in docstring |
coordinates/memory.py |
coordiante → coordinate in inline comment |
coordinates/base.py |
existance → existence, overriden → overridden in docstrings |
coordinates/__init__.py |
overriden → overridden (×3) in module docstring |
coordinates/TRC.py |
occurences → occurrences in inline comment |
coordinates/PQR.py |
coordiantes → coordinates in module docstring |
coordinates/H5MD.py |
postion → position in error message string |
converters/RDKitInferring.py |
dependant → dependent in docstring |
auxiliary/base.py |
indicies → indices in docstring |
analysis/rms.py |
occured → occurred in docstring |
analysis/rdf.py |
occurences → occurrences (×2) in docstrings |
analysis/msd.py |
reccomended → recommended in module docstring |
analysis/legacy/x3dna.py |
the the → the in docstring |
analysis/hydrogenbonds/wbridge_analysis.py |
the the → the in inline comment |
analysis/encore/utils.py |
indeces → indices (×3) in docstrings |
analysis/encore/covariance.py |
coordiantes → coordinates in docstring |
analysis/dielectric.py |
dependant → dependent (×4) in docstring |
analysis/align.py |
the the → the in docstring |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * Leading whitespace is ignored. | ||
|
|
||
| The *convertor* is a function that converts its single argument to | ||
| The *converter* is a function that converts its single argument to |
There was a problem hiding this comment.
The docstring was updated to reference the parameter as *converter*, but the actual function parameter is still named convertor (line 52: def kv2dict(s, convertor: Any = str):). This creates an inconsistency between the docstring and the function signature—the docstring now describes a parameter name that doesn't exist in the function. Either the parameter itself should be renamed from convertor to converter (which would also require updating the call sites at lines 307 and 381 that use convertor=float), or the docstring should be reverted to *convertor* to match the actual parameter name.
| The *converter* is a function that converts its single argument to | |
| The *convertor* is a function that converts its single argument to |
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## develop #5263 +/- ##
===========================================
- Coverage 93.83% 86.14% -7.69%
===========================================
Files 180 180
Lines 22473 22473
Branches 3189 3189
===========================================
- Hits 21088 19360 -1728
- Misses 923 2660 +1737
+ Partials 462 453 -9 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Changes made in this Pull Request:
LLM / AI generated code disclosure
LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution: no
PR Checklist
package/CHANGELOGfile updated?package/AUTHORS?Developers Certificate of Origin
I certify that I can submit this code contribution as described in the [Developer Certificate of Origin](https://developercertificate.org/), under the MDAnalysis [LICENSE](https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE).
📚 Documentation preview 📚: https://mdanalysis--5263.org.readthedocs.build/en/5263/