Skip to content

docs: fix off-by-one hl_lines in apps.md - #3196

Merged
maxisbey merged 1 commit into
mainfrom
fix-apps-docs-hl-lines
Jul 27, 2026
Merged

docs: fix off-by-one hl_lines in apps.md#3196
maxisbey merged 1 commit into
mainfrom
fix-apps-docs-hl-lines

Conversation

@maxisbey

Copy link
Copy Markdown
Contributor

#3034 added an import line to docs_src/apps/tutorial001.py, which shifted the highlighted lines in both apps.md snippets that include it — the first block was highlighting four blank lines instead of the "four moves" the prose walks through. Bumps both specs by one.

Flagged in #3190 (comment) (the second block wasn't mentioned there but has the same shift).

The tutorial001.py snippet gained an import line, shifting every
highlighted line down by one; both blocks referencing it now
highlight the intended lines instead of blanks.

No-Verification-Needed: doc-only line-number fix
@maxisbey
maxisbey marked this pull request as ready for review July 27, 2026 23:01
@github-actions

Copy link
Copy Markdown
Contributor

📚 Documentation preview

Preview https://pr-3196.mcp-python-docs.pages.dev
Deployment https://6aebb2e4.mcp-python-docs.pages.dev
Commit 38b57bb
Triggered by @maxisbey
Updated 2026-07-27 23:02:36 UTC

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

@maxisbey
maxisbey merged commit b61ce38 into main Jul 27, 2026
38 checks passed
@maxisbey
maxisbey deleted the fix-apps-docs-hl-lines branch July 27, 2026 23:04

@claude claude 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.

LGTM — straightforward docs fix bumping two hl_lines specs by one after #3034 added an import to docs_src/apps/tutorial001.py.

What was reviewed:

  • Verified both new specs against the current tutorial001.py: 19 22 30 32 land on the four lines the "Four moves" prose enumerates (Apps(), @apps.tool, add_html_resource, MCPServer), and 23-27 covers the get_time body with the client_supports_apps branch discussed under graceful degradation.
  • Checked the other hl_lines blocks in apps.md (tutorial002/003) are untouched and unaffected — they include different files.
Extended reasoning...

Overview

Single-file docs change to docs/advanced/apps.md: two hl_lines attributes on snippet-include code blocks are each shifted up by one (18 21 29 3119 22 30 32 and 22-2623-27). Both blocks include docs_src/apps/tutorial001.py, which gained an import line in #3034, shifting every subsequent line down by one.

Security risks

None. This is pure documentation markup — no code, config, or build behavior changes.

Level of scrutiny

Minimal scrutiny is appropriate: the change is mechanical and fully verifiable. I cross-checked the new line numbers against the current docs_src/apps/tutorial001.py and confirmed they highlight exactly the lines the surrounding prose describes — the "four moves" list and the get_time fallback logic. The old numbers landed on blank lines and off-by-one targets, consistent with the PR description.

Other factors

The fix was flagged in review discussion on #3190, and this PR also corrects the second block that shares the same shift. No open reviewer comments on the timeline, no test or coverage implications, and the change follows the existing snippet-highlighting convention in the file.

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