[FIX] Apply Ruff fix to tutorial and user guide. - #1300
Conversation
Pyright Type CompletenessView the full Project (full
Other symbols referenced but not exported by
Symbols without documentation:
Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## gd_ruff_fix_adjustments #1300 +/- ##
========================================================
Coverage 91.67% 91.67%
========================================================
Files 96 96
Lines 5444 5444
Branches 702 702
========================================================
Hits 4991 4991
Misses 332 332
Partials 121 121
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
meta comment, do we want to get rid of black in these notebooks now? |
Yeah, since we switched linters. It's in the Governing Doc so I don't think we need the cell or the paragraph explaining it anymore. |
Summary of Changes
Stacked PR on top of #1290. Fixes user guide and tutorial files.
Related GitHub Issue(s)
#1216
Additional Context for Reviewers
Checklist
uv run pytest) and documentation changes (uv run --directory docs jb build . --builder=custom --custom-builder=doctest)Note
Low Risk
Doc-only notebook formatting and lint fixes with no intended change to library behavior or runtime logic.
Overview
Brings getting-started tutorial and user guide Jupyter notebooks in line with the repo’s Ruff lint and format settings, following the broader Ruff rollout (#1216) on top of #1290.
Changes are mechanical in notebook code cells—things like unused import removal, syntax/style fixes covered by the configured rule set, and Ruff formatter layout—across the long-form docs under
docs/getting_started/tutorials/anddocs/user_guide/. Example behavior and outputs in the notebooks should be unchanged; this is mainly so CI and pre-commit Ruff checks pass on those doc sources.Reviewed by Cursor Bugbot for commit 8d2f02e. Bugbot is set up for automated code reviews on this repo. Configure here.