atom-community / atom-community/ide-python

Improve feature provider option descriptions

Aperta
#98 4 commenti 1 reazione 0 assegnatari Vedi su GitHub
documentation good first issue
Lingua principale
JavaScript
Stelle
238
Fork
40
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con le descrizioni delle opzioni dei plugin in package.json, in particolare le righe 67-350, e confronta ogni voce con la documentazione del relativo provider della funzionalità. Aggiorna le descrizioni o aggiungi link pertinenti alla documentazione quando sono inesatte o troppo basilari. Il lavoro è completato quando le descrizioni delle impostazioni di Atom sono più chiare e accurate per le opzioni esaminate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.