-
Notifications
You must be signed in to change notification settings - Fork 104
Various, minor, grammar changes and fixes #655
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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). |
There was a problem hiding this comment.
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.
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. |
There was a problem hiding this comment.
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'.
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.
There was a problem hiding this 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.
There was a problem hiding this 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.
There was a problem hiding this 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.
Preview the changes: https://turinglang.org/docs/pr-previews/655 |
There was a problem hiding this 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.
This PR improves the documentation quality with various grammar and spelling fixes.
Changes
LICENCE
toLICENSE
Files affected
41 files across tutorials, usage guides, and developer documentation have been updated for consistency and clarity.