Skip to content

docs: fix typos and snippet names in getting started tutorial - #2178

Open
bhawna346 wants to merge 1 commit into
sbi-dev:mainfrom
bhawna346:docs-fix-getting-started-typos
Open

bhawna346 wants to merge 1 commit into
sbi-dev:mainfrom
bhawna346:docs-fix-getting-started-typos

Conversation

@bhawna346

Copy link
Copy Markdown

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 x in the boxes that apply. If you are unsure about any of them, just
ask - we are happy to help.

  • [ x] I have read the contributing guide.
  • uv run pytest -n auto -m "not slow and not gpu" passes.
  • uv run pre-commit run --all-files passes (ruff and formatting).
  • uv run pyright sbi passes.
  • I added or updated tests for the changed behavior.
  • I used Google-style docstrings for new or changed public functions.
  • (If applicable) I reported how long new tests run and marked slow ones
    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.

@coderabbitai

coderabbitai Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

Explain Change →

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

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Other

Suggested reviewers: michaeldeistler

Merge Risk: Minimal · up to 2d849

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: Passed 4

Check name Status Explanation
Title check Passed 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 Passed 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 Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed 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.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant