Inconsistencies between docs & integration test examples
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- python
調査の方向性
Compare the documentation examples with the integration test examples, starting with the user-defined axes page linked in the issue and its corresponding test example. Check both the code snippets and the identifiers used for examples and reference images. The synchronization is complete when the docs match the tested examples and the expected plots are picked up.
索引モデルが issue の本文から書いたものです。
説明
With the refactor in #123 the associated bug fix PRs, there have been changes to the examples both in terms of the code snippets themselves and the ID used to tag them (usually a number perhaps with a letter prefix but not always). Therefore much of the docs examples are now out of date from what we test and generate the corresponding plots on. And some plots that should get embedded are not being picked up because the identifier in the reference image no longer matches that quoted (see e.g. https://ncas-cms.github.io/cf-plot/user_defined.html#example-21a-user-defined-axes).
They should be synchronised ASAP so the live docs are accurate.
Ideally we can go beyond that and draw both the docs and integration test code from the same source to ensure they remain in sync going forward too, but I am yet to decide the best solution to achieve this. So for the upcoming bug-fix release I will syncronise only. And later think of the long-term solution.
- 主要言語
- Python
- スター
- 21
- フォーク
- 11
- 平均マージ
- 2日 21時間
- マージ済み PR（30日）
- 7
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NCAS-CMS/cf-plot のほかの issue
-
docs enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
-
Add badges to READMEオープンdocs
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
dependencies infrastructure installation testing
難易度 1/5 1〜3時間 初心者へのやさしさ 78/100
-
testing
難易度 4/5 1〜2日 初心者へのやさしさ 45/100
NCAS-CMS/cf-plot の issue をすべて見る
似ている issue
-
fuzz fuzz-unconfirmed
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
ready-for-agent
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
neilsh/stunt-reel#220 ·
メンテナーはふだん 1 日以内に返信
-
[Issue]: use_fp4_cache is accepted but ignored; the launcher always writes FP8 records対応中かも @0z5a が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
area: cli priority: p3 size: S type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
finos/open-resource-broker#757 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 6 日以内に返信