nf() function description inadequate
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
調査の方向性
processing.org/reference/nf_.html にある対象の nf() リファレンスページを開き、現在の説明と Syntax および Parameter セクションを確認してください。float と array の入力に対する異なる呼び出し形式と必須パラメーターを明確にしてください。初心者が各入力型にどのシグネチャが適用されるか判断できれば、作業は完了です。
索引モデルが issue の本文から書いたものです。
説明
Issue description
nf() function reference could use a better description. As of now the text says:
Utility function for formatting numbers into strings. There are two versions: one for formatting floats, and one for formatting ints. The values for the digits and right parameters should always be positive integers. The left parameter should be positive or 0. If it is zero, only the right side is formatted.
This text only states that an int and a float version is existent. Nowhere is it explained how those are different. Referring to this description a call like nf(float, int) would be valid. This call however is not functional as passing num as a float variable requires to specify a left and right parameter (so the call has to be nf(float, int, int)).
This could be confusing to beginner programmers.
URL(s) of affected page(s)
https://processing.org/reference/nf_.html
Proposed fix
In my opinion ideally, in line with single responsibility, these would be two functions.
However an extended description should also do the trick.
The text could be extended by a paragraph similar to:
When num is a variable of type float the call becomes
nf(num, left, right). left represents the formatted number left of the decimal point and right represents the formatting right of the decimal point.
Alternatively it could be made clear in the Syntax and Parameter section which call allows which parameters.
nf(numf, left, right)
nf(numsf, left, right)
numf = float: the number to format
numsf = float[]: the numbers to format
- 主要言語
- MDX
- スター
- 90
- フォーク
- 122
- 平均マージ
- 1時間 20分
- マージ済み PR（30日）
- 4
環境構築
このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
processing/processing-website のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
processing/processing-website#716 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
processing/processing-website#703 ·
メンテナーはふだん 1 日以内に返信
-
Good First Issue Help Wanted Reference
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
processing/processing-website#698 · コメント 5 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
processing/processing-website#681 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
processing/processing-website#646 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
processing/processing-website の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
microsoft/onnxruntime#33018 ·
メンテナーはふだん 2 日以内に返信
-
missing content writing algorithms
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
QuantConnect/Documentation#2739 ·
メンテナーはふだん 1 日以内に返信
-
:watch: Not Triaged dotnet-target-version
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
copilot documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
lichess-org/api#678 ·