Typo cleanup: Python descriptions/comments and VHDL comments#1422
Merged
Conversation
ruck314
changed the title
Post-PR #1421 cleanup pass focused on English-word typos in user-facing prose, plus one small kwargs-collision fix retained from the original audit. No behavioural change. Net changes: 143 files, +237/-237 lines. Python typos -- 24 files, 39 fixes Audited every .py under python/ and tests/ via 6 parallel review passes. tests/ was clean. Highlights: analog_devices/_Adt7420.py Analod Deviced -> Analog Devices analog_devices/_Ad9249.py Regsisters -> Registers analog_devices/_Ad9249.py Compliment -> Complement silabs/_Si5{324,326,5345Lite,5394Lite}.py conflagration -> configuration silabs/_Si5345Pages.py Ready Only -> Read Only ti/_Ads54J54.py dcimation -> decimation ti/_Lmk61e2.py retreived -> retrieved xilinx/_AxiSysMonUltraScale.py Managment -> Management xilinx/_AxiSysMonUltraScale.py defatul -> default protocols/jesd204b/_JesdRx.py / _JesdTx.py brake/missaligned/Indicades/undeflow/funtionality/ checkes/re-syncronisations -> fixed British spellings (synchronised, re-synchronisations) preserved where already used. VHDL typos -- 119 files, 197 fixes Audited every .vhd under axi/, base/, devices/, dsp/, ethernet/, protocols/, and xilinx/ via 8 parallel review passes (1146 files total). Only -- comment text was touched. No signal, port, process, entity, generic, or component names were renamed; no string literals in report/assert statements were modified. Most prevalent (boilerplate copy-paste families): 7Series GT clones (gtx7/gth7/gtp7) sucessfully -> successfully (x9) Tranceiver -> Transceiver (x3) PGP Axi banners Errror -> Error (x6) pgp2b/pgp2fc/pgp3 *Pkg / *RxPhy / *RxCell occured -> occurred (x10) XauiCore wrappers adn -> and (x16 in repeated boilerplate) AD9249/AD9681 readout primatives/primative/curDealy -> primitives/primitive/curDelay xvc-udp JTAG paylod/paralle/the the -> fixed Real-English-word substitutions verified per occurrence (not bulk-replaced): weather->whether, it->if, na->and, od->of, got->go, dessert->deassert, rests->resets, with->without, read->ready, an->and, save->same, though->through, knowns->knows, incase->in case, to to->to, the the->the, Interfac e->Interface Pre-flight verified that every misspelled string only appears in -- comment lines (never as an identifier or in code) before any bulk substitution. British spellings preserved. AdcTester kwargs fix -- 1 file The only kwarg-hardening change retained from the post-PR #1421 audit: python/surf/devices/analog_devices/_Ad9249.py AdcTester.__init__ accepts description as a named parameter, eliminating the TypeError: got multiple values for keyword argument 'description' when a caller passes description=. The other 8 wrappers identified in the original audit (AxiMonAxiL, Ltm4664, Si5345, Si5394, PhantomS711, PMBus, Pgp3AxiL, Pgp4AxiL) were prepared but reverted; they remain at their pre-release shape. Verification: python -m compileall -f python/ -- clean flake8 --count python/ -- 0 scripts/vsg_linter.sh -- No issues found cocotb regression suite NOT run locally; it requires the make MODULES=$PWD import HDL pipeline only available in CI.
ruck314
force-pushed
the
description-cleanup
branch
from
b471731 to
2869a21
Compare
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## pre-release #1422 +/- ##
================================================
- Coverage 36.66% 25.61% -11.06%
================================================
Files 28 242 +214
Lines 1459 18355 +16896
================================================
+ Hits 535 4702 +4167
- Misses 924 13653 +12729 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bengineerd
approved these changes
May 18, 2026
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
3 participants
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.
Post-PR #1421 cleanup. 143 files, +237/-237 lines, no behavioural change.
description=, docstrings, comments, and error messages (tests/audited clean).report/assertstring literals modified. Pre-flight verified every misspelled string only appears in--comments before any bulk substitution._Ad9249.py__init__acceptsdescriptionas a named parameter — the only kwarg-hardening fix retained from the original post-PR Removed redundant description attribute causing software to fail #1421 audit.Verification:
compileallclean ·flake8 --count python/=0·scripts/vsg_linter.shNo issues found · cocotb suite not runnable locally (CI-onlymake MODULES=$PWD importpipeline).