Tutorial 'continue.scrbl' signatures rendering confusing to readers
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
web-server-doc/web-server/scribblings/tutorial/continue.scrbl から始め、そこで使われているシグネチャのレンダリングを調べてから、関連するマニュアルのフォーマットを理解するために scribble-lib/scribble/private/manual-proc.rkt を読んでください。チュートリアルの説明とシグネチャの間隔をリンク先の例と比較してください。完了の条件は、シグネチャが直前の説明と視覚的に結び付いており、後続の段落とは分離されていることです。
索引モデルが issue の本文から書いたものです。
説明
The rendering of signatures in the Continue tutorial is confusing to readers
In the tutorial, functions are often described, then followed by their signature in the familiar scribble/manual format.
Unfortunately the hairline at the top of the signature, in addition to the large gap above, and lack of a gap below gives the impression the signature is associated with the subsequent text.
My suggestion is the rendering of continue is changed to support the 'description followed by signature' style of the text. I'd suggest moving the hairline to the bottom of the signature, and increasing the spacing between the signature and the subsequent paragraph.
Options to resolve;
- a different css stylesheet for continue.scribble
- an new signature function that handles spacing differently
- other options?
https://github.com/racket/scribble/blob/master/scribble-lib/scribble/private/manual-proc.rkt
- 主要言語
- Racket
- スター
- 100
- フォーク
- 48
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
racket/web-server のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
racket/web-server#46 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
racket/web-server#141 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
racket/web-server#140 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
racket/web-server#135 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
racket/web-server#131 · コメント 1 件 ·
racket/web-server の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
carpentries/workshop-template#918 ·
-
Logo Redirectオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
-
Purestorage backend configuration example contains hyphens instead of underscores対応中かも @wilkmar が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 67/100
materialdigital/core-ontology#528 ·
メンテナーはふだん 1 日以内に返信
-
triage-needed
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
MicrosoftDocs/edge-developer#3970 ·
メンテナーはふだん 1 日以内に返信