You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: fix typos and snippet names in getting started tutorial - #2178
I have corrected two typos (“constraint” and “diagnonal”) in the notebook of Getting Started tutorial.
I have renamed variables present in the code snippet (simulate → simulator, x_o → x_obs) so that they match the actual code given below.
Also there are follow-up fixes to #2174 and the changes are made on separate lines.
Does this close any issues?
No issue. This complements #2174, which fixes other typos in the Getting Started tutorial .
Anything else we should know?
This is a docs-only change, so the test, pyright and docstring items do not apply. Pre-commit passed on the changed file when committing.
Checklist
Put an x in the boxes that apply. If you are unsure about any of them, just
ask - we are happy to help.
No actionable comments were generated in the recent review.
Walkthrough
The getting-started tutorial now calls simulator(theta) and passes x_obs to posterior.sample. It also corrects two wording errors.
Changes: Getting-started tutorial
Layer / File(s)
Summary
Example and text corrections docs/tutorials/00_getting_started.ipynb
The example calls simulator(theta) and passes x_obs to posterior.sample. The tutorial changes “constraint” to “constrains” and “diagnonal” to “diagonal.”
This updates the Getting Started tutorial text and snippet names to match the code. It does not change runtime behavior and is ready to merge.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title names the main change: typo fixes and snippet variable renames in the Getting Started tutorial notebook. The raw summary confirms the notebook changes match this title (simulate to simulator…
Description check
The description covers the main sections of the template: what the PR does (two typo fixes and variable renames in the tutorial), related issues (no issue, complements #2174), and additional notes (do…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title names the main change: typo fixes and snippet variable renames in the Getting Started tutorial notebook. The raw summary confirms the notebook changes match this title (simulate to simulator, x_o to x_obs, 'constraint' to 'constrains', 'diagnonal' to 'diagonal'). The 'docs:' prefix fits a documentation-only change.
Full details: Description check
Explanation
The description covers the main sections of the template: what the PR does (two typo fixes and variable renames in the tutorial), related issues (no issue, complements #2174), and additional notes (docs-only, pre-commit passed, AI assistant use disclosed). The checklist is filled in, with the test, pyright, and docstring items unchecked and explained as not applicable. The 'Does this close any issues?' section says 'No issue' rather than giving a link, which is acceptable here. One small gap: the first checklist item is written as '[ x]' with a stray space, so it may not render as checked. Minor formatting issues in the description, such as the note that the changes are 'on separate lines', do not affect the assessment.
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: 7ad1ddc1-6bea-4fb7-9f38-e87c21319230
Commits
Reviewing files that changed from the base of the PR and between 799e324 and 2d849a8.
Files selected for processing: 1
docs/tutorials/00_getting_started.ipynb
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
This branch has not been deployed
No deployments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
I have corrected two typos (“constraint” and “diagnonal”) in the notebook of Getting Started tutorial.
I have renamed variables present in the code snippet (simulate → simulator, x_o → x_obs) so that they match the actual code given below.
Also there are follow-up fixes to #2174 and the changes are made on separate lines.
Does this close any issues?
No issue. This complements #2174, which fixes other typos in the Getting Started tutorial .
Anything else we should know?
This is a docs-only change, so the test, pyright and docstring items do not apply. Pre-commit passed on the changed file when committing.
Checklist
Put an
xin the boxes that apply. If you are unsure about any of them, justask - we are happy to help.
uv run pytest -n auto -m "not slow and not gpu"passes.uv run pre-commit run --all-filespasses (ruff and formatting).uv run pyright sbipasses.with
pytest.mark.slow.I used an AI assistant to understand the tutorial and to spot these typos. I made and checked each change myself.