Visitar URL original
Render `<see langword="..."/>` in API docs and tool tips by xperiandri · Pull Request #1371 · fsprojects/FSharp.Formatting · GitHub
Skip to content

Render <see langword="..."/> in API docs and tool tips - #1371

Merged
nojaf merged 3 commits into
fsprojects:mainfrom
xperiandri:fix/see-langword
Nov 6, 2026
Merged

nojaf merged 3 commits into
fsprojects:mainfrom
xperiandri:fix/see-langword

Conversation

@xperiandri

Copy link
Copy Markdown
Contributor

Fixes #1370

<see langword="true"/> rendered as nothing, so Returns <see langword="true"/> when … read "Returns when …". The API docs now show the keyword as inline code, the same as <c>true</c>, and a snippet tool tip keeps the word, the way it already keeps the name of a <see cref>.

Details
  • API docs: readXmlElementAsHtml writes <code>keyword</code> for a <see> that has langword and no cref.
  • Tool tips: tryReadXmlDoc takes the text from langword as it does from cref and name.
  • Both new tests failed before the fix: See langword renders as inline code (HTML and Markdown) and A see langword keeps its keyword in the sentence it sits in.
  • Lint, build, pack, tests and the strict docs build pass locally on Windows with SDK 10.0.402, and the analyzers report nothing on the changed files.

🤖 Generated with Claude Code

xperiandri and others added 2 commits November 6, 2026 10:33
A <see langword="true"/> has no cref, so the API docs wrote nothing for it
and a tool tip replaced it with its empty text. The API docs now write the
keyword as inline code, the same as <c>true</c>, and a tool tip keeps the
word.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread RELEASE_NOTES.md Resolved

@nojaf nojaf left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good from afar, thanks!

@xperiandri xperiandri changed the title Render <see langword="..."/> in API docs and tool tips Render <see langword="..."/> in API docs and tool tips Nov 6, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@nojaf
nojaf merged commit 8db0713 into fsprojects:main Nov 6, 2026
4 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.

<see langword="..."/> renders as nothing in API docs

2 participants