Skip to content

docs: make bash get treated correctly - #1143

Merged
gabwow merged 3 commits into
mainfrom
nvbug6562813-fix-bad-bash-cell/agabow
Aug 7, 2026
Merged

docs: make bash get treated correctly#1143
gabwow merged 3 commits into
mainfrom
nvbug6562813-fix-bad-bash-cell/agabow

Conversation

@gabwow

@gabwow gabwow commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Related Issue

Changes

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification:
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted validation:

Summary by CodeRabbit

  • Documentation
    • Updated the throughput optimization tutorial notebook to run its package-installation command explicitly as a Bash cell.
    • Reformatted the notebook’s closing metadata without changing its content.

@gabwow
gabwow requested review from a team as code owners August 6, 2026 21:20
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f7af5ba5-ae4e-4598-9ba1-b6598ead891d

📥 Commits

Reviewing files that changed from the base of the PR and between 018a9f1 and 6c0700c.

📒 Files selected for processing (3)
  • docs/customizer/tutorials/optimize-throughput.ipynb
  • docs/fern/components/notebooks/optimize-throughput.json
  • docs/fern/components/notebooks/optimize-throughput.ts
🚧 Files skipped from review as they are similar to previous changes (3)
  • docs/fern/components/notebooks/optimize-throughput.ts
  • docs/fern/components/notebooks/optimize-throughput.json
  • docs/customizer/tutorials/optimize-throughput.ipynb

📝 Walkthrough

Walkthrough

The throughput tutorial dependency-installation cells now explicitly use %%bash. The existing package-selection logic remains unchanged.

Changes

Throughput tutorial notebook

Layer / File(s) Summary
Bash installation cell and notebook closure
docs/customizer/tutorials/optimize-throughput.ipynb, docs/fern/components/notebooks/optimize-throughput.json, docs/fern/components/notebooks/optimize-throughput.ts
The installation cells now use %%bash. The existing environment detection and package installation logic remains unchanged. The notebook’s final JSON delimiter was rewritten without functional changes.

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main documentation change: explicitly treating the notebook installation cell as Bash.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nvbug6562813-fix-bad-bash-cell/agabow

Comment @coderabbitai help to get the list of available commands.

@gabwow
gabwow enabled auto-merge August 7, 2026 15:23
@github-actions github-actions Bot added the docs label Aug 7, 2026
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 31727/40339 78.6% 63.3%
Integration Tests 18444/38269 48.2% 20.9%

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/fern/components/notebooks/optimize-throughput.ts`:
- Around line 41-43: Update the notebook conversion logic in
ipynb-to-fern-json.py to detect cells whose source begins with %%bash and assign
them Bash rather than Python, ensuring source_html is regenerated with Bash
highlighting. Then regenerate optimize-throughput.ts so its language metadata
and highlighted HTML match the Bash cell.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 7d31093c-5099-47fb-91af-a0bee10e001b

📥 Commits

Reviewing files that changed from the base of the PR and between e26f614 and c196018.

📒 Files selected for processing (2)
  • docs/fern/components/notebooks/optimize-throughput.json
  • docs/fern/components/notebooks/optimize-throughput.ts

Comment thread docs/fern/components/notebooks/optimize-throughput.ts
gabwow added 2 commits August 7, 2026 19:18
Signed-off-by: Aaron Gabow <agabow@nvidia.com>
Signed-off-by: Aaron Gabow <agabow@nvidia.com>
@gabwow
gabwow force-pushed the nvbug6562813-fix-bad-bash-cell/agabow branch from c196018 to f21b6a0 Compare August 7, 2026 23:19
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@gabwow
gabwow added this pull request to the merge queue Aug 7, 2026
Merged via the queue into main with commit 197b032 Aug 7, 2026
55 checks passed
@gabwow
gabwow deleted the nvbug6562813-fix-bad-bash-cell/agabow branch August 7, 2026 23:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants