atom-community / atom-community/ide-python

Improve feature provider option descriptions

Offen
#98 4 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
documentation good first issue
Vorherrschende Sprache
JavaScript
Sterne
238
Forks
40
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit den Beschreibungen der Plugin-Optionen in package.json, insbesondere mit den Zeilen 67–350, und vergleiche jeden Eintrag mit der Dokumentation des jeweiligen Feature-Providers. Aktualisiere Beschreibungen oder füge relevante Dokumentationslinks hinzu, wenn sie ungenau oder zu oberflächlich sind. Als erledigt gilt die Aufgabe, wenn die Beschreibungen der Atom-Einstellungen für die überprüften Optionen klarer und genauer sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.