Skip to content

docs: Fix rate limiting section link - #4719

Merged
gmlewis merged 1 commit into
google:masterfrom
ktsoator:docs/fix-rate-limiting-link
Nov 15, 2026
Merged

gmlewis merged 1 commit into
google:masterfrom
ktsoator:docs/fix-rate-limiting-link

Conversation

@ktsoator

@ktsoator ktsoator commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

While reading the README's iterator section, I noticed that the Rate Limiting link points to the site root. This removes the leading / so the link jumps to the Rate Limiting section within the README.

Verified in VS Code's Markdown preview. Checks passed: script/fmt.sh, script/test.sh, and script/lint.sh (including script/generate.sh --check).

I initially tested this in the latest version of GoLand, where the updated link still wouldn't jump to the section. It works in VS Code's Markdown preview, so this may be an issue with GoLand's preview.

@ktsoator

Copy link
Copy Markdown
Contributor Author

While reading the README's iterator section, I noticed that the Rate Limiting link points to the site root. This removes the leading / so the link jumps to the Rate Limiting section within the README.

Verified in VS Code's Markdown preview. Checks passed: script/fmt.sh, script/test.sh, and script/lint.sh (including script/generate.sh --check).

I initially tested this in the latest version of GoLand, where the updated link still wouldn't jump to the section. It works in VS Code's Markdown preview, so this may be an issue with GoLand's preview.

GoLand converts the space before a heading’s closing ### into an extra trailing hyphen in the anchor, causing the correct #rate-limiting link to fail to resolve.

image

The closing ### is optional and valid Markdown syntax, so this appears to be a GoLand issue.

@gmlewis gmlewis changed the title docs(readme): Fix rate limiting section link docs: Fix rate limiting section link Nov 15, 2026
@gmlewis
gmlewis merged commit 5d83c3d into google:master Nov 15, 2026
6 checks passed
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