docs: fix typos in notebooks, docstrings and knowledgebase - #1150
Merged
drbenvincent merged 1 commit intoAug 8, 2026
Merged
Conversation
Found with aspell over extracted prose, then reviewed by hand. codespell runs in prek and in CI but reports clean, since its dictionary only holds known misspelling pairs and none of these are in it. Spelling: engodgenous, endogeniety (3x), catgeorical, horsehoe, counterfailing, hyperparamers, crediblity, proxmity, relevent, prevalance, weigting, threhsold, treamtent, umeasured, approximtely, stochasticisty, empircal, determinents, additionlly, dummary, jusst, perior, dats, TWe, partialied, caual, tracebak. Also six doubled words (five "the the", one "See See"), "it effects the causal path" to "affects", the book title "Mastering'metrics" to match references.bib, and the notebook_to_markdown docstring naming its own whitelist file "codespeel-whitelist.txt". Notebooks were edited as raw text rather than via a JSON round-trip, which would have reformatted two of them. Each replacement was checked to occur only inside cell sources, never in outputs, since base64 image blobs contain fragments like TWe and dats.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## pymc6_and_pymcmarketing1_migration #1150 +/- ##
===================================================================
Coverage 97.11% 97.11%
===================================================================
Files 122 122
Lines 21634 21634
Branches 1175 1175
===================================================================
Hits 21009 21009
Misses 414 414
Partials 211 211 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
drbenvincent
merged commit Aug 8, 2026
edd8782
into
pymc6_and_pymcmarketing1_migration
16 checks passed
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
2 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.
Fixes 38 typos across 17 files: notebook prose, two Python comments, the knowledgebase glossary and one docstring. No code behaviour changes.
Why codespell did not catch these
codespell runs in prek and in CI (the CI job converts notebooks to markdown first, so notebooks are covered), and it reports clean both before and after this change. Its dictionary only holds known misspelling pairs and none of these words are in it. I found them by running aspell over extracted prose and reviewing the words that occur only once or twice.
What changed
Spelling: engodgenous, endogeniety (3x, including
glossary.rst), catgeorical, horsehoe, counterfailing, hyperparamers, crediblity, proxmity, relevent, prevalance, weigting, threhsold, treamtent, umeasured, approximtely, stochasticisty, empircal, determinents, additionlly, dummary, jusst, perior, dats, TWe, partialied, caual, tracebak.Six doubled words: five "the the" and one "See See".
Three are not pure spelling and are worth a second look:
causal_written_resources.md, matching the title inreferences.bib.notebook_to_markdown.pynamed its own whitelist file "codespeel-whitelist.txt" in its docstring.Notebook edits
I edited the notebooks as raw text instead of reading and rewriting the JSON, because a JSON round-trip reformats two of them and would have buried the change in a large diff. Each replacement was checked to occur only inside cell sources and never in outputs, since base64 image blobs contain fragments like TWe and dats. No cells were re-executed, so the rendered docs change only in the prose.
Verification
test_outcome_falsification.py(29 passed) and the negd tests (27 passed), run inCausalPy-pymc6.