atom-community / atom-community/ide-python

Improve feature provider option descriptions

Open
#98 4 comments 1 reaction 0 assignees View on GitHub
documentation good first issue
Dominant language
JavaScript
Stars
238
Forks
40
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start with the plugin option descriptions in package.json, especially lines 67-350, and compare each entry with the documentation for its specific feature provider. Update descriptions or add relevant documentation links where they are inaccurate or too basic. Done means the Atom settings descriptions are clearer and more accurate for the options reviewed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.