Improve discoverability of family names and improve the user experience in related error messages
評価
この issue はまだ評価されていません。
説明
I was just helping someone out with running picotool uf2 convert because it was complaining that the family ID rp2350 was not valid. I've never used this tool before, so my first port of call was to run the help command. This did not provide any information on what the family ID should be for an RP2350. I looked at the README file on this repository, which did not appear to have a section listing the supported family names. I then tried searching the source code for family_id, --family, rp2350, and some of the constant values to try to discover what the flag should be. This did not help either - GitHub's search couldn't find where constants were defined, and I couldn't spot a location where all family names are enumerated. In the end I searched the closed issues for "rp2350" and found some examples that showed that the family ID should've been either rp2350-riscv or rp2350-arm-s. I think this user experience can be significantly improved.
The first thing I would like to request is a picotool list families command that lists the family IDs that are supported by the tool. This makes the families much more discoverable, directly within the tool. Implementing this as a list command (instead of, say, picotool list-families) provides a common basis for future functionality that lists other entities for easy discovery. Including this list in the readme would also be helpful, but this is secondary to having it directly in the tool.
The second thing I would like to request is a modification to the error message when an invalid family ID is provided. The error message should, of course, be updated to point the user to the new picotool list families command, instead of the more general help page. In addition, I think it would be helpful to perform a substring search on the erroneous family name that was provided by the user and return any matches as suggestions. For example, if a user enters rp2350, the error message should suggest "perhaps you meant one of these families: rp2350-arm-s, rp2350-riscv". Similarly, if a user enters RP2350-ARM, the error message should suggest "perhaps you meant rp2350-arm-s". This message would provide instant and helpful feedback without the user needing to execute a second command to discover the correct family name.
- 主要言語
- C++
- スター
- 1k
- フォーク
- 195
- 平均マージ
- 11日 5時間
- マージ済み PR（30日）
- 4
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
raspberrypi/picotool のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
raspberrypi/picotool#371 · コメント 1 件 ·
-
seal: ECDSA signature r/s shorter than 32 bytes is written wrong (der_to_raw copies 32-len bytes), ~1 in 256 seals do not verify対応中かも @will-v-pi が 59 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
raspberrypi/picotool#365 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
raspberrypi/picotool#347 ·
-
`picotool seal` corrupts ELF files built with IAR toolchain対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 4/5 1〜2日 初心者へのやさしさ 55/100
raspberrypi/picotool#374 ·
-
Add 'partition' options to 'save' and 'verify' commands対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
raspberrypi/picotool#348 ·
raspberrypi/picotool の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
DarkCastleMUD/DarkCastle#283 ·
-
-priority- blocked good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
scribe-org/Scribe-Android#761 · コメント 2 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Bug Testing
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
SCIInstitute/SCIRun#2931 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 5 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信