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

オープン 初心者向け
  • 何か問題がありますか？
#1,370 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
fsharp
領域
documentation

調査の方向性

まず、src/FSharp.Formatting.ApiDocs/XmlDocReader.fs の193～213行にある see と seealso の処理を確認してください。リーダーが cref をどのように処理するか、また c 要素がどのようにインラインコードになるかを確認し、関連するAPIドキュメントのテストを追ってください。true のような langword の値が消えずにインラインコードとして表示されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

XmlDocReader renders a <see> or <seealso> element only when it has a cref attribute (XmlDocReader.fs#L193-L213). <see langword="true"/>, the .NET way to reference a keyword, has no cref, so the word is lost: /// <summary>Returns <see langword="true"/> when the event has at least one handler.</summary> renders as "Returns when the event has at least one handler." The expected output is the keyword as inline code, the same as <c>true</c>.

FSharp.Core starts to use langword in dotnet/fsharp#20940, so its API reference shows the gap.

主要言語
F#
スター
492
フォーク
160
平均マージ
3日 14時間
マージ済み PR（30日）
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

fsprojects/FSharp.Formatting のほかの issue

fsprojects/FSharp.Formatting の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。