Better docstrings for geojson attributes
オープン
まだ誰も着手していません。
documentation
feature
P2
- 主要言語
- JavaScript
- スター
- 18.3k
- フォーク
- 2k
- 平均マージ
- 2日 12時間
- マージ済み PR（30日）
- 28
説明
We provide some geojson attributes but it's not obvious from our docstrings what can/can't be passed. This causes issues especially for LLMs trying to generate Plotly charts with geojson attributes, and frequent hallucination.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず geojson 属性の定義を見つけ、現在の docstring を読みます。渡すことができる値とできない値を特定し、その後、サポートされている入力が明示されるようにドキュメントを更新し、説明が issue で言及されている geojson 属性を網羅していることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript
- 領域
- data-visualization, documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100