Various, minor, grammar changes and fixes by AoifeHughes · Pull Request #655 · TuringLang/docs

AoifeHughes · 2025-10-03T10:23:52Z

This PR improves the documentation quality with various grammar and spelling fixes.

Changes

British English spelling: Standardized spelling throughout (e.g., "optimise" instead of "optimize")
Grammar corrections: Fixed article usage (a/an), removed duplicate words, and improved sentence structure
Enhanced documentation links: Added more Wikipedia and reference links for better context
Footer fix: Corrected license link from LICENCE to LICENSE

Files affected

41 files across tutorials, usage guides, and developer documentation have been updated for consistency and clarity.

Copilot

Pull Request Overview

This PR focuses on standardizing spelling conventions throughout the documentation, specifically converting American English spellings to British English variants. The changes are primarily in comments and documentation text rather than functional code.

Converts American spellings to British equivalents (e.g., "optimization" → "optimisation", "visualization" → "visualisation")
Removes duplicate words and fixes minor grammatical issues
Updates package name references for consistency

Reviewed Changes

Copilot reviewed 16 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
usage/tracking-extra-quantities/index.qmd	Changes "parameterization" to "parameterisation"
usage/sampler-visualisation/index.qmd	Removes duplicate "and" in HMC description
usage/mode-estimation/index.qmd	Updates "Optimization.jl" to "Optimisation.jl" references
usage/external-samplers/index.qmd	Changes "optimization" to "optimisation" and "initialization" to "initialisation"
usage/automatic-differentiation/index.qmd	Changes "optimization" to "optimisation"
tutorials/variational-inference/index.qmd	Multiple spelling changes and function renaming for consistency
tutorials/probabilistic-pca/index.qmd	Changes "visualization" to "visualisation" and removes duplicate "the"
tutorials/multinomial-logistic-regression/index.qmd	Changes "normalizing" to "normalising" and "Standardize" to "Standardise"
tutorials/bayesian-logistic-regression/index.qmd	Changes "normalizing" to "normalising"
tutorials/bayesian-linear-regression/index.qmd	Changes "visualization" to "visualisation" and "normalizing" to "normalising"
tutorials/bayesian-differential-equations/index.qmd	Changes "optimization" to "optimisation"
faq/index.qmd	Changes "vectorized" to "vectorised"
developers/inference/variational-inference/index.qmd	Changes "maximize" to "maximise" and "parameterization" to "parameterisation"
developers/inference/abstractmcmc-interface/index.qmd	Changes "parameterization" to "parameterisation"
core-functionality/index.qmd	Changes "Initialize" to "Initialise" and "visualization" to "visualisation"
README.md	Changes "License" to "Licence" and removes line break

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot

Pull Request Overview

Copilot reviewed 34 out of 35 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

tutorials/probabilistic-pca/index.qmd:1

Corrected spelling of 'coordinats' to 'coordinates'.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot

Pull Request Overview

Copilot reviewed 39 out of 40 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot

Pull Request Overview

Copilot reviewed 39 out of 40 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

github-actions · 2025-10-06T13:33:25Z

Preview the changes: https://turinglang.org/docs/pr-previews/655
Please avoid using the search feature and navigation bar in PR previews!

Copilot

Pull Request Overview

Copilot reviewed 40 out of 41 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

mhauru

Broadly happy with this, a few requests.

mhauru · 2025-10-13T10:20:24Z

 `mtcars` contains a variety of statistics on different car models, including their miles per gallon, number of cylinders, and horsepower, among others.

-We want to know if we can construct a Bayesian linear regression model to predict the miles per gallon of a car, given the other statistics it has.
+We want to know if we can construct a Bayesian linear regression model to predict the miles per gallon of a car, given the other statistics it possesses.


I find the original version of this, "has", clearer and easier to read. Do you have a reason for preferring "possesses"?

Changed "possesses" back to "has"

mhauru · 2025-10-13T10:41:30Z

-This is because we set the second parameter of the NUTS sampler (which is the number of adaptations) to be equal to 200.
+The initial samples during the [warmup phase](https://en.wikipedia.org/wiki/Markov_chain_Monte_Carlo) show higher variability and should be discarded before computing posterior statistics.
+Thus, we remove these warmup samples and view the diagnostics again.
+We discard the first 200 samples, corresponding to the adaptation phase used by the NUTS sampler (specified via the `discard_adapt=false` argument above).


Suggested change

We discard the first 200 samples, corresponding to the adaptation phase used by the NUTS sampler (specified via the `discard_adapt=false` argument above).

We discard the first 200 samples, corresponding to the adaptation phase used by the NUTS sampler (which we explicitly chose not to discard earlier with `discard_adapt=false` argument).

Added clarification about the discard_adapt=false

mhauru · 2025-10-13T11:10:39Z

 [JuliaGPs](https://github.com/JuliaGaussianProcesses/#welcome-to-juliagps) packages integrate well with Turing.jl because they implement the Distributions.jl
 interface.
-You should be able to understand what is going on in this tutorial if you know what a GP is.
+This tutorial assumes familiarity with [Gaussian processes](https://en.wikipedia.org/wiki/Gaussian_process); for an introduction, see [Rasmussen and Williams (2006)](http://www.gaussianprocess.org/gpml/).


I feel like "familiarity" could mean a lot of things, from "roughly knows what a GP is" to "works in the field, eats GPs for breakfast". Could we specify a bit more? Especially if the answer is more like the former, in which case I wouldn't want to scare people away.

Softened in latest commit

mhauru · 2025-10-13T11:53:20Z

              </div>
              <div class="footer-bottom">
-                <p>Turing.jl was created by <a href="https://mlg.eng.cam.ac.uk/hong/" target="_blank" rel="noopener">Hong Ge</a>, and maintained by the core <a href="https://turinglang.org/team/" target="_blank" rel="noopener">team</a> of developers and <a href="https://github.com/TuringLang/Turing.jl/graphs/contributors" target="_blank" rel="noopener">contributors</a>.<br>© 2025 The Turing Project Contributors. <a href="https://github.com/TuringLang/Turing.jl/blob/master/LICENCE" target="_blank" rel="noopener">MIT License</a>.</p>
+                <p>Turing.jl was created by <a href="https://mlg.eng.cam.ac.uk/hong/" target="_blank" rel="noopener">Hong Ge</a>, and maintained by the core <a href="https://turinglang.org/team/" target="_blank" rel="noopener">team</a> of developers and <a href="https://github.com/TuringLang/Turing.jl/graphs/contributors" target="_blank" rel="noopener">contributors</a>.<br>© 2025 The Turing Project Contributors. <a href="https://github.com/TuringLang/Turing.jl/blob/master/LICENSE" target="_blank" rel="noopener">MIT License</a>.</p>


I'm confused by this one. https://github.com/TuringLang/Turing.jl/blob/master/LICENCE, the old link, seems to be correct, no?

Lemme check, I realised in my haste to fix spellings that I broke a file / ref link so maybe I double corrected.

Ping me for a rereview once you're done.

mhauru · 2025-10-13T11:54:24Z

 # Turing.jl Documentation and Tutorials

-**https://turinglang.org/docs/**
+**https://turinglang.org/docs/**  


Is this file just getting a lot of trailing whitespace added, or am I missing something?

Thanks, I was having weird markdown rendering for me, so I assumed it was some kind of needing extra space. Fixed in last commit.

mhauru · 2025-10-13T11:57:38Z

+## License  

-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [License](License) file for details.


Suggested change

This project is licensed under the MIT License - see the [License](License) file for details.

This project is licensed under the MIT License - see the [License](LICENSE) file for details.

The link breaks if the capitalisation doesn't match the filename.

Fixed in commit about to be pushed once I finish replying to comments

AoifeHughes added 2 commits October 3, 2025 11:06

British Eng "z" -> "s"

03b1b6f

misc grammar and double word fixes

8eb9d6e

AoifeHughes requested a review from Copilot October 3, 2025 10:23

AoifeHughes self-assigned this Oct 3, 2025

AoifeHughes added the enhancement New feature or request label Oct 3, 2025

Copilot AI reviewed Oct 3, 2025

View reviewed changes

AoifeHughes added 2 commits October 3, 2025 11:48

an fixes

13939b5

a million little grammar rewrites

1191c62

AoifeHughes requested a review from Copilot October 6, 2025 08:00

Copilot AI reviewed Oct 6, 2025

View reviewed changes

AoifeHughes added 2 commits October 6, 2025 10:07

more British-isms and grammar changes

a9d5ef9

Grammar, plus added back and more links (mostly wiki)

2a73b0a

AoifeHughes requested a review from Copilot October 6, 2025 10:29

Copilot AI reviewed Oct 6, 2025

View reviewed changes

AoifeHughes added 2 commits October 6, 2025 12:31

reluctantly changing license to match original file

d98fdb0

gross, the library itself uses American spelling.

96faf58

AoifeHughes requested a review from Copilot October 6, 2025 11:32

Copilot AI reviewed Oct 6, 2025

View reviewed changes

Fix license link in footer from 'LICENCE' to 'LICENSE'

94e1a6f

AoifeHughes marked this pull request as ready for review October 7, 2025 08:11

AoifeHughes requested a review from Copilot October 7, 2025 08:11

Copilot AI reviewed Oct 7, 2025

View reviewed changes

AoifeHughes mentioned this pull request Oct 7, 2025

Review and merge grammar and clarity improvements from PR #655 #657

Closed

6 tasks

AoifeHughes requested a review from mhauru October 13, 2025 09:05

mhauru requested changes Oct 13, 2025

View reviewed changes

AoifeHughes added 2 commits October 13, 2025 13:05

fixed whitespace

0c7f940

bump with Mhauru's change suggestions

51e047e

TuringLang deleted a comment from Copilot AI Nov 21, 2025

penelopeysm added 4 commits November 21, 2025 19:10

Merge branch 'main' into ah-grammar

ab9cbaf

semantic line breaks

164b365

fix

8400b67

Merge branch 'main' into ah-grammar

207cd3c

penelopeysm merged commit e5abd70 into main Nov 21, 2025
1 check failed

penelopeysm deleted the ah-grammar branch November 21, 2025 19:14

github-actions bot added a commit that referenced this pull request Nov 21, 2025

Remove preview for merged PR #655

1b7f8b4

	We discard the first 200 samples, corresponding to the adaptation phase used by the NUTS sampler (specified via the `discard_adapt=false` argument above).
	We discard the first 200 samples, corresponding to the adaptation phase used by the NUTS sampler (which we explicitly chose not to discard earlier with `discard_adapt=false` argument).

	This project is licensed under the MIT License - see the [License](License) file for details.
	This project is licensed under the MIT License - see the [License](LICENSE) file for details.

Conversation

AoifeHughes commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Files affected

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

github-actions bot commented Oct 6, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

mhauru left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AoifeHughes commented Oct 3, 2025 •

edited

Loading