Use `<see langword>` for keywords in XML docs

オープン
#20,943 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
fsharp, xml
領域
documentation

調査の方向性

The issue identifies 53 XML documentation locations across 10 files under src/FSharp.Core and one more under vsintegration/src; begin by reviewing the change in #20940 and the renderer follow-ups #20941, #20939, and fsprojects/FSharp.Formatting#1370. Replace the keyword markup only after all listed renderers support langword. Done means those renderer issues are resolved and the replacements cover the listed codebase locations.

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

説明

Needs-Triage

The XML docs in src/FSharp.Core write keywords as <c>true</c>, <c>false</c> and <c>null</c> (53 places in 10 files), and vsintegration/src has one more. The .NET convention is <see langword="true"/>, which C# and Visual Studio show as a keyword. #20940 is the first use.

Replace them across the code base when all renderers handle langword:

  • F# Interactive #help drops the word: #20941
  • Visual Studio Quick Info shows it as plain text: #20939
  • fsdocs, which builds the FSharp.Core API reference, drops it: fsprojects/FSharp.Formatting#1370
主要言語
F#
スター
4.3k
フォーク
883
平均マージ
3日 4時間
マージ済み PR(30日)
88

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

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

dotnet/fsharp のほかの issue

dotnet/fsharp の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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