Fix typos in docstrings, RST documentation, and source comments#36
Merged
Fix typos in docstrings, RST documentation, and source comments#36
Conversation
Co-authored-by: gb119 <4428426+gb119@users.noreply.github.com> Agent-Logs-Url: https://github.com/stonerlab/Stoner-PythonCode/sessions/b3814012-1284-48e4-a2c7-7bfb5ed3d732
Copilot
AI
changed the title
[WIP] Fix typos in docstrings and markdown files
Fix typos in docstrings, RST documentation, and source comments
Mar 21, 2026
Test Results 3 files ±0 3 suites ±0 16m 49s ⏱️ - 1m 3s For more details on these failures and errors, see this check. Results for commit 1367ccd. ± Comparison against base commit 6cb282d. |
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.
Systematic codespell scan of the stable branch identified 145 typos across docstrings, RST docs, and inline comments. All fixes are cosmetic — no functional logic changed.
Documentation (
doc/,README.rst)README.rst/doc/readme.rst: Python, compatible, distribution, metadata, hierarchy, choice, facilities, arbitrary, inheritance, deprecate, releasesdoc/conf.py,doc/Stoner.rst,doc/analysis-fitting.rstdoc/UserGuide/: 8 RST files covering analysisfile, cookbook, curve_fitting, datafile, datafolder, developer, image, plotfile, upgradedoc/samples/stitch.py,stitch_int_overlap.pyPython source (
Stoner/)core/:base.py,data.py,interfaces.py,methods.py,array.pyanalysis/:columns.py,filtering.py,functions.py,utils.py, fitting classes/functions/modelsImage/:attrs.py,core.py,imagefuncs.py,kerr.py,widgets.pyfolders/:core.py,groups.py,methods.py,mixins.py,utils.pyformats/:attocube.py,decorators.py,maximus.py,data/subpackageplot/:core.py,formats.pytools/:decorators.py,file.py,tests.pyNotable recurring patterns fixed:
menthod→method(11×),shouldbe→should be,Couldn;t→Couldn't,givem→given,repalce→replace.💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.