Skip to content

docs(server): fix line-wrapped code span in HTTP/3 note - #30591

Merged
alii merged 1 commit into
mainfrom
claude/docs-http3-codespan-wrap
May 12, 2026
Merged

alii merged 1 commit into
mainfrom
claude/docs-http3-codespan-wrap

Conversation

@alii

@alii alii commented May 12, 2026

Copy link
Copy Markdown
Member

Follow-up to #30583.

Prettier wrapped the inline `http3: true` span across two lines inside the <Note>, so per CommonMark code-span rules the newline + 2-space indent become literal spaces and it renders as http3: true.

Dropped the redundant "always" so the line fits under printWidth: 120 and stays prettier-stable.

Docs-only, no build needed.

Follow-up to #30583. Prettier wrapped the inline `http3: true` span
across two lines inside the <Note>, which renders as `http3:   true`
(newline + indent become literal spaces per CommonMark code-span rules).
Dropped the redundant "always" so the line fits under printWidth: 120.
@robobun

robobun commented May 12, 2026 •

Copy link
Copy Markdown
Collaborator
Updated 4:18 PM PT - May 12th, 2026

✅ @alii, your commit 1f1b2ab83b95e8e90898def21f10ba577ebd9653 passed in Build #53878! 🎉


🧪   To try this PR locally:

bunx bun-pr 30591

That installs a local version of the PR into your bun-30591 executable, so you can run:

bun-30591 --bun

@alii
alii merged commit 3bf4b33 into main May 12, 2026
6 of 8 checks passed
@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: ca148ff6-5676-4101-89a9-bc602fc2afda

📥 Commits

Reviewing files that changed from the base of the PR and between 0d9b296 and 1f1b2ab.

📒 Files selected for processing (1)
  • docs/runtime/http/server.mdx

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


Walkthrough

The HTTP/3 documentation note in the server configuration guide is consolidated into a single line, combining two related constraints: http3 incompatibility with unix domain sockets and the requirement that http1: false must be paired with http3: true.

Changes

HTTP/3 constraint documentation

Layer / File(s) Summary
HTTP/3 constraint note consolidation
docs/runtime/http/server.mdx
The documentation note clarifying http3 socket and http1 mode constraints is consolidated from multiple lines into a single sentence for readability.

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

@alii
alii deleted the claude/docs-http3-codespan-wrap branch May 12, 2026 23:18

@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 — trivial docs whitespace/wording fix.

Extended reasoning...

Overview

This PR touches a single line in docs/runtime/http/server.mdx, unwrapping an inline code span inside a <Note> block and dropping the redundant word "always". The change fixes a rendering artifact where Prettier's line-wrap caused the code span to render as http3: true (with extra spaces) per CommonMark code-span rules.

Security risks

None. This is a documentation-only change with no executable code, configuration, or build implications.

Level of scrutiny

Minimal. It's a one-line cosmetic/formatting fix in prose docs, a direct follow-up to #30583. The semantic content is unchanged ("always requires" → "requires" conveys the same constraint), and the new line is 116 chars, comfortably under the stated printWidth: 120 so it should remain prettier-stable.

Other factors

No bugs were flagged by the bug-hunting system, no CODEOWNERS cover this path, and there are no outstanding reviewer comments. The change is self-evidently correct from the diff alone.

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.

2 participants