Repository navigation
Conversation
why: Prose code literals link every name that resolves to one member. A keyword argument names a parameter of the call being described, so Ruby's `cancel:` linked to Cancellation#cancel, `clients: true` to Snapshot#clients, and `action:` to an unrelated Workspace member. what: - Add SymbolIndex.linkLiteral, which leaves `name:` and `name: value` plain and links other literals as before - Use it for HTML prose, and skip keyword arguments in Markdown export - Test that keyword arguments stay plain while the bare name still links
Contributor
Author
|
Folded into #157, which now carries every fix from the 2026-10-18 review on one branch so they share one CI run, preview and deploy. This commit is on that branch unchanged. Discussion and evidence stay here. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prose code literals link every name that resolves to exactly one member. A keyword argument names a parameter of the call being described, so the Ruby
Serverreference linkedcancel:toCancellation#cancel,clients: truetoSnapshot#clients,where:toSelection#where, andaction:to an unrelated WorkspaceApplyResultmember.A literal shaped like a keyword argument (
name:orname: value) now stays plain in HTML and in Markdown exports. A bare name such ascancelstill links. Selectors likename(_:)and paths likestd::stringdon't match the pattern.Tests:
site/test/inline-reference-appearance.test.tschecks Ruby HTML and TypeScript Markdown; it fails without the rule. The site suite (4,599 passed) and the api-model suite (942) pass.