docs: fix factual errors, inconsistencies, and typos in the guide#800
Merged
Conversation
- packaging tutorial: fix wrong Snell's law output value - pytest guide: fix inverted skipif condition, strict-markers describes markers not fixtures, add missing assert in approx example - packaging-simple: requires-python upper-cap check is PP004, not PY004 - packaging-compiled: "pure Python project" link pointed at itself - gha-basic: step output reference missing .outputs. - gha-wheels: fix mis-indented pull_request trigger; test-groups not test-extras - tasks: fix broken hatch URL (pypa, not pypi) - style: fix flake8-print URL and stray ) in Ruff v2 badge - docs: fix corner example link (pointed at astropy) - data-files: unify peak_spacings directory name - test tutorial: align dir tree and pytest output with snell example, drop incorrect Arrange-Act-Assert reference Assisted-by: ClaudeCode:claude-opus-4.8
- index: repair broken intro sentence
- guides/index: "on for" -> "one for"
- packaging-simple: "you you use"
- coverage: dangling "either with"
- gha-pure: complete trailing sentence about publish guard
- docs: "snipits" -> "snippets", reframe "Popular frameworks" note,
fix stale linkcheck-handler prose
- mypy: add self to Protocol/impl methods
- backports: importlib.metadata, tomli_w, tzdata
- design: "One alternative is to replace"
- testing: venerable, autospec=True, numpy ndarray
- tutorials/docs: fix {toctree} fence and "interoperate"
Assisted-by: ClaudeCode:claude-opus-4.8
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
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
1 participant
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.
Ran Opus on the guide. It actually ran in one go (the other two sites I did it fanned out), so maybe I should have tried Fable.
Also added
CLAUDE.mdto the gitignore (it should just be a symlink toAGENTS.md, Claude Code is the only harness not to follow the standard).🤖 AI text below 🤖
Review of
docs/pages/turned up a batch of concrete errors. Split into two commits: factual/code fixes first, then typos/grammar.Commit 1 — factual / code errors & inconsistencies
These would actively mislead a reader who copied the snippets:
snell(np.pi/4, 1.00, 1.33)output (1.2239576240104186→0.5605584137424605, the value the other two pages already use)skipifcondition;--strict-markersdescribed as checking fixtures (it's markers); missingassertin theapproxexamplePP004, notPY004(PY004is "has docs folder").outputs.pull_requesttrigger (was nested underrelease:);test-extras→test-groupshatch.pypi.io→hatch.pypa.io)flake8-printURL; stray)in the Ruff v2 badgecornerexample link pointed at astropypeak_spacingsdirectory name (was drifting betweenpeak_spacing/peakspacing)Commit 2 — typos & grammar
Broken intro sentence on the home page, "on for"→"one for", "you you use", a dangling "either with", an incomplete sentence in gha-pure, "snipits"→"snippets", a reframed (self-contradictory) "Popular frameworks" note, stale linkcheck-handler prose, missing
selfon Protocol methods,importlib.metadata/tomli_w/tzdatafixes,autospec=True, numpyndarray, and a malformed{toctree}fence.rumdlandprettierpass on the changed files.Left untouched: the forward-looking pytest 9+ config block (
[tool.pytest]withstrict = true) — speculative future syntax rather than a clear error.📚 Documentation preview 📚: https://scientific-python-cookie--800.org.readthedocs.build/