Skip to content

Conversation

AoifeHughes
Copy link
Contributor

@AoifeHughes AoifeHughes commented Oct 3, 2025

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.

@AoifeHughes AoifeHughes requested a review from Copilot October 3, 2025 10:23
@AoifeHughes AoifeHughes self-assigned this Oct 3, 2025
@AoifeHughes AoifeHughes added the enhancement New feature or request label Oct 3, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

README.md Outdated

If there isn't a suitably up-to-date `_freeze` folder in the releases, you can generate a new one by [triggering a run for the `create_release.yml` workflow](https://github.com/TuringLang/docs/actions/workflows/create_release.yml).
(You will need to have the appropriate permissions; please create an issue if you need help with this.)
If there isn't a suitably up-to-date `_freeze` folder in the releases, you can generate a new one by [triggering a run for the `create_release.yml` workflow](https://github.com/TuringLang/docs/actions/workflows/create_release.yml) (You will need to have the appropriate permissions; please create an issue if you need help with this).
Copy link
Preview

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

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

The formatting change removes appropriate line breaks and creates an overly long line that reduces readability.

Suggested change
If there isn't a suitably up-to-date `_freeze` folder in the releases, you can generate a new one by [triggering a run for the `create_release.yml` workflow](https://github.com/TuringLang/docs/actions/workflows/create_release.yml) (You will need to have the appropriate permissions; please create an issue if you need help with this).
If there isn't a suitably up-to-date `_freeze` folder in the releases, you can generate a new one
by [triggering a run for the `create_release.yml` workflow](https://github.com/TuringLang/docs/actions/workflows/create_release.yml)
(You will need to have the appropriate permissions; please create an issue if you need help with this).

Copilot uses AI. Check for mistakes.

README.md Outdated
## Licence

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

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

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

The link reference 'Licence' appears to be incorrect. It should likely reference 'LICENSE' (the actual filename) rather than 'Licence'.

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

Copilot uses AI. Check for mistakes.

@AoifeHughes AoifeHughes requested a review from Copilot October 6, 2025 08:00
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@AoifeHughes AoifeHughes requested a review from Copilot October 6, 2025 10:29
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@AoifeHughes AoifeHughes requested a review from Copilot October 6, 2025 11:32
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

github-actions bot commented Oct 6, 2025

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

@AoifeHughes AoifeHughes marked this pull request as ready for review October 7, 2025 08:11
@AoifeHughes AoifeHughes requested a review from Copilot October 7, 2025 08:11
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant