Small documentation mistake

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

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

評価

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

調査の方向性

リンクされた Database.Persist.Sql.Class のソースを開き、EntityWithPrefix の近くにあるコメントを見つけます。ドキュメントコメント内の先頭の @ 記号をエスケープし、その後、レンダリングされたソースドキュメントにリテラル記号として表示されることを確認します。

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

説明

Near EntityWithPrefix, there's the line:

The symbol is a "type application" and requires the TypeApplications@ language extension.

which in the source file is

-- The @ symbol is a "type application" and requires the @TypeApplications@
-- language extension.

That first @ symbol should be escaped, methinks.

主要言語
Haskell
スター
486
フォーク
307
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

yesodweb/persistent のほかの issue

yesodweb/persistent の issue をすべて見る

似ている issue

Haskell の issue をもっと見る

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

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