Stale code comments found while writing the format docs

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

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

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

評価

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

調査の方向性

RecordFileWriter.Write、RecordField.ContentMediaType、MarkdownDiagnosticIds、ADR 0032、ADR 0029、READMEから始めてください。PR #166はフォーマットのドキュメントに関する背景情報を提供します。クリップボード形式に関する別のissueも含め、各コメントとドキュメントの記述を、issueで説明されているコードの動作と照らし合わせてください。古くなった4つの記述すべてが現在の動作と一致したら完了です。

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

説明

The code is right in each case; only the comments are wrong.

  1. RecordFileWriter.Write's summary says every rich value is a |- block, but under R-8 fields of paragraphs are written with |.
  2. RecordField.ContentMediaType's comment says references are text/x-fieldworks-markdown, but the code returns text/x-fieldworks-markdown-inline. Record the -inline type in ADR 0032 as well.
  3. MarkdownDiagnosticIds says link.ambiguous and link.broken are 'reported by hosts', but ObjectBuilder emits both.
  4. ADR 0029 and the README say the Markdown library 'will provide' the FieldWorks Markdown clipboard form. Only the id constant exists; see the separate issue for the form itself.
    Found by the format-docs work (PR #166).
主要言語
C#
スター
0
フォーク
0
平均マージ
1時間 43分
マージ済み PR（30日）
43

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

sillsdev/SIL.TextEditing のほかの issue

sillsdev/SIL.TextEditing の issue をすべて見る

似ている issue

C# の issue をもっと見る

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

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