Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Various, minor, grammar changes and fixes #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
03b1b6f
British Eng "z" -> "s"
Oct 3, 2025
8eb9d6e
misc grammar and double word fixes
Oct 3, 2025
13939b5
an fixes
Oct 3, 2025
1191c62
a million little grammar rewrites
Oct 6, 2025
a9d5ef9
more British-isms and grammar changes
Oct 6, 2025
2a73b0a
Grammar, plus added back and more links (mostly wiki)
Oct 6, 2025
d98fdb0
reluctantly changing license to match original file
Oct 6, 2025
96faf58
gross, the library itself uses American spelling.
Oct 6, 2025
94e1a6f
Fix license link in footer from 'LICENCE' to 'LICENSE'
Oct 6, 2025
0c7f940
fixed whitespace
Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ venv
site_libs
.DS_Store
index_files
digest.txt
digest.txt
*.bak
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Contributing

The easiest way to contribute to the documentation is to simply open a pull request.
A preview version of the documentation is built for PRs, so you can see how your changes look without having to build the entire site locally.
A preview version of the documentation is built for pull requests, so you can see how your changes look without having to build the entire site locally.
(Note that if you are editing a tutorial that takes a long time to run, this feedback may take a while.)

The `main` branch contains the Quarto source code.
Expand Down Expand Up @@ -52,7 +52,7 @@ Then:
```

This will build the entire documentation and place the output in the `_site` folder.
You can then view the rendered website by launching a HTTP server from that directory, e.g. using Python:
You can then view the rendered website by launching an HTTP server from that directory, e.g. using Python:

```bash
cd _site
Expand Down Expand Up @@ -81,9 +81,8 @@ If you wish to speed up local rendering, there are two options available:

Note that the validity of a `_freeze` folder depends on the Julia environment that it was created with, because different package versions may lead to different outputs.
In the GitHub release, the `Manifest.toml` is also provided, and you should also download this and place it in the root directory of the docs.

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).

## Troubleshooting build issues

Expand All @@ -103,4 +102,4 @@ pkill -9 -f quarto

## 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.
2 changes: 1 addition & 1 deletion _quarto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ format:

</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>
Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

Ping me for a rereview once you're done.

<a href="https://github.com/TuringLang/docs/" target="_blank" rel="noopener" class="footer-source-link"><i class="bi bi-github"></i> Website Source</a>
</div>
</div>
Expand Down
12 changes: 6 additions & 6 deletions core-functionality/index.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ using Turing
# Add four processes to use for sampling.
addprocs(4; exeflags="--project=$(Base.active_project())")

# Initialize everything on all the processes.
# Initialise everything on all the processes.
# Note: Make sure to do this after you've already loaded Turing,
# so each process does not have to precompile.
# Parallel sampling may fail silently if you do not do this.
Expand Down Expand Up @@ -329,7 +329,7 @@ Inputs to the model that have a value `missing` are treated as parameters, aka r
```{julia}
@model function gdemo(x, ::Type{T}=Float64) where {T}
if x === missing
# Initialize `x` if missing
# Initialise `x` if missing
x = Vector{T}(undef, 2)
end
s² ~ InverseGamma(2, 3)
Expand All @@ -344,7 +344,7 @@ model = gdemo(missing)
c = sample(model, HMC(0.05, 20), 500)
```

Note the need to initialize `x` when missing since we are iterating over its elements later in the model.
Note the need to initialise `x` when missing since we are iterating over its elements later in the model.
The generated values for `x` can be extracted from the `Chains` object using `c[:x]`.

Turing also supports mixed `missing` and non-`missing` values in `x`, where the missing ones will be treated as random variables to be sampled while the others get treated as observations.
Expand Down Expand Up @@ -376,7 +376,7 @@ using Turing

@model function generative(x=missing, ::Type{T}=Float64) where {T<:Real}
if x === missing
# Initialize x when missing
# Initialise x when missing
x = Vector{T}(undef, 10)
end
s² ~ InverseGamma(2, 3)
Expand Down Expand Up @@ -597,10 +597,10 @@ logging is enabled as default but might slow down inference. It can be turned on
or off by setting the keyword argument `progress` of `sample` to `true` or `false`.
Moreover, you can enable or disable progress logging globally by calling `setprogress!(true)` or `setprogress!(false)`, respectively.

Turing uses heuristics to select an appropriate visualization backend. If you
Turing uses heuristics to select an appropriate visualisation backend. If you
use Jupyter notebooks, the default backend is
[ConsoleProgressMonitor.jl](https://github.com/tkf/ConsoleProgressMonitor.jl).
In all other cases, progress logs are displayed with
[TerminalLoggers.jl](https://github.com/c42f/TerminalLoggers.jl). Alternatively,
if you provide a custom visualization backend, Turing uses it instead of the
if you provide a custom visualisation backend, Turing uses it instead of the
default backend.
Loading
Loading