Repository navigation
Reword comments and docs in plain language - #12
Merged
Merged
Conversation
djgormley
force-pushed
the
style/voice-review
branch
from
October 27, 2026 04:06
2db5298 to
85ed8f4
Compare
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.
Rewrites the comments, docstrings, docs, READMEs and CHANGELOG wording so they read plainly and in one voice. I went through all 584 code and doc files in the repo and changed 413 of them. The step-by-step explanations added in #11 for the detector and archive code keep their detail, but the semicolon chains, "not X" framing, dash asides, banners, arrows and history notes ("now", "previously", "kernel core 2.2.0 adds") are gone, and the mechanism sentences are in the passive. Line comments are short lowercase fragments, docstrings open with a purpose line, and British spellings are now American. No code changed. This branch sits on top of #11, so it should go in after that one.
A number of comments didn't match the code, so I fixed them while I was there. The
fine_reductiondocstring pointed at a GPU test file that doesn't exist, and now namestest_cupy_fine_reduction_matches_float64_prototype_within_ulp_gate. The DS001 data sheet said per-pilot products store CFAR columns and an any-bin detection list, but onlyfine_power_u64and the contract scalars are stored, as PRODUCT_SCHEMA.md says. USAGE.md called the guard and reference offsets fine bins (they're detector bins) and said both shipped profiles use 16384-sample frames, which is only true of the reference and CHIME profiles._run_jsonsaid it never raises, but it raises SystemExit when the CLI doesn't accept--json.test_c_header.cstill said core 3.0.0 ABI whileconfig.his at 4.0.0, and thefxfft256_ref.cself-check exits with status 2 where the comment said it aborts. The line-number citations in the archive tests had all drifted, so they name the function now.Checked on Python 3.12 (archive-local venv), running the
make release-checksteps one by one.ruff check .,generate_doc_specs.py --check,check_no_legacy_guard_terms.sh, the sixcheck_current_*scripts,emit_fxfft_tables.py --checkandcompileallall pass.pytest tests -q -p no:cacheprovider --ignore=tests/kernel --deselect tests/core/test_reference_pfb_gpu.pygives 3673 passed, 71 skipped and 2 deselected.make -C cuda test_c_header test_refbuilds and runs, and the check-profile, check-layout, bundle export and validate, and list-channels commands from release-check all exit 0. The GPU tests were run during the edit on the RTX 5000 Ada (pytest tests/kernelgave 109 passed, andmake -C cuda testat K=128 passed). Every changed Python, C, CUDA, shell, YAML and TOML file has the same code as the base once comments and docstrings are stripped. The other 49 files are Markdown, TeX, TikZ and text, and their code blocks are unchanged except for comment lines. DS001 and UG001 build with latexmk, and the three standalone figures build with pdflatex.Comment edits change file hashes, and a few tools check their own.
operating_policy.pyrejects a policy compiled from the old bytes,current_geometry_sensitivity.pywon't reuse a study directory from the old driver, the SDR runners andrun_fine_validation_campaign.pyrefuse plans prepared before the edit, and a per-pilot checkpoint won't resume becausepackage_source_sha256changes. So any of those that are in flight should finish before this merges. The dtv-rs model_band records pin the hash oftools/validate_proxy_confidence_band.pyat commit 0ef044e, so they have to be reproduced from that commit. A rebuiltlibpilotproxy.sowon't be byte-identical to the kernel builds of record, because__LINE__shows up in the error messages, but the arithmetic is the same. The kotekan copy offxfft256_ref.cnow differs from this one in comments only.I didn't touch anything under docs/evidence, docs/runtime_freezes or the dated data/provenance directories, since those are frozen records. Both evidence
verify.pyscripts and the three SHA256SUMS still pass. The same goes for the generated files (fxfft_master_twiddle.h,wvu_palette.py,wvu_palette.tex), the LimeSuite headers, CITATION.cff,freeze_estimator_transfer.py(its blob is checked against the publication tag), and the two worker .cpp files whose hashes are pinned in the evidence. Printed, asserted and hashed strings weren't touched either, so some help text and output strings still have dropped spaces ("approximately310kHz", "must be1", "All0.001 rows") from 1.0.0. Those need a code change. A few doc disagreements also need a decision before I touch them. The datapath figure labels the fine decision "(deployed)" while DS001 calls it an inactive candidate. METHOD_SPEC and DESIGN_DECISIONS describe channel 14's lower reference differently. And docs/ADDING_A_READER.md and docs/archive-results-design.md are cited but missing, so either the docs get written or the references change.