atom-community / atom-community/ide-python
Improve feature provider option descriptions
- 主要言語
- JavaScript
- スター
- 238
- フォーク
- 40
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
At this point the [descriptions of the plugin options](https://github.com/lgeiger/ide-python/blob/master/package.json#L67-L350) visible in the Atom settings are rather basic and often less accurate than what can be found in the documentation of the specific feature provider.
We should improve those descriptions and/or link to the relevant docs if applicable.
Any help on this is highly appreciated. This issue doesn't need to be fixed in one go, we can iteratively improve the plugin documentation.
コントリビューションガイド
調査の方向性
package.json のプラグインオプションの説明、特に 67-350 行目から始め、各エントリをそれぞれの機能プロバイダーのドキュメントと比較します。不正確または基本的すぎる説明は更新するか、関連するドキュメントへのリンクを追加します。確認したオプションについて Atom 設定の説明がより明確で正確になれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100