atom-community / atom-community/ide-python

Improve feature provider option descriptions

未关闭
#98 4 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
documentation good first issue
主要语言
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

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。