Skip to content

DOC: fix typos in documentation - #596

Merged
redeboer merged 7 commits into
mainfrom
docs/fix-typos
Oct 14, 2026
Merged

redeboer merged 7 commits into
mainfrom
docs/fix-typos

Conversation

@MTerwissen

@MTerwissen MTerwissen commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Closes #595

📝 Documentation

  • Fixed typos, doubled words, and grammar in docs/usage.ipynb, docs/usage/basics.ipynb, docs/usage/caching.ipynb, docs/usage/faster-lambdify.ipynb, and docs/amplitude-analysis/analytic-continuation.ipynb. Most notably, the faster-lambdify page now says that sub-expressions are lambdified separately and then recombined, and the second caveat in the hit-and-miss warning of docs/usage/basics.ipynb now reads as a sentence ("If the function displays narrow structures, […] chances are smaller that […]").
  • Fixed further spelling and grammar mistakes in docs/amplitude-analysis.ipynb, docs/usage/chi-squared.ipynb, docs/usage/unbinned-fit.ipynb, and docs/install.md, such as "the helicity formalism boosts", "simplify the expression", "an UnbinnedNLL", and "To get JAX and TensorFlow to work".
  • Fixed the spelling of "expression" in the docstring of create_cached_function().

🖱️ Developer experience

  • Disabled allowCompoundWords in .cspell.json, so that misspellings can no longer pass as concatenations of valid words. Legitimate technical terms that were previously accepted as compounds are now listed in the cSpell dictionary.

🔨 Maintenance

  • Renamed the private function get_jit_compile_dectorator() to get_jit_compile_decorator() and fixed a misspelled local variable in the tests.

Squash commit messages

* DX: disallow compound words in cspell
* MAINT: fix typos in private function names

@MTerwissen MTerwissen added the 📝 Docs Improvements or additions to documentation label Oct 14, 2026
@MTerwissen
MTerwissen requested a balanced review from Copilot October 14, 2026 13:00

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@MTerwissen
MTerwissen requested a review from redeboer October 14, 2026 13:01
redeboer

This comment was marked as resolved.

@redeboer redeboer added 🔨 Maintenance Maintenance and upkeep improvements 🖱️ DX Improvements to the Developer Experience labels Oct 14, 2026
@redeboer redeboer added this to the 0.4.18 milestone Oct 14, 2026

@redeboer redeboer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM! 🦒

@redeboer redeboer removed the 🔨 Maintenance Maintenance and upkeep improvements label Oct 14, 2026
@redeboer
redeboer merged commit 96c79ad into main Oct 14, 2026
27 of 28 checks passed
@redeboer
redeboer deleted the docs/fix-typos branch October 14, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Typos and grammar errors in the usage documentation

4 participants