atom-community / atom-community/ide-python

Improve feature provider option descriptions

Ouverte
#98 4 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
documentation good first issue
Langage dominant
JavaScript
Étoiles
238
Forks
40
Métriques de merge des PR
Aucune PR mergée en 30 j

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par les descriptions des options des plugins dans package.json, en particulier les lignes 67-350, et comparez chaque entrée à la documentation de son fournisseur de fonctionnalités spécifique. Mettez à jour les descriptions ou ajoutez des liens pertinents vers la documentation lorsqu’elles sont inexactes ou trop élémentaires. La tâche est considérée comme terminée lorsque les descriptions des paramètres d’Atom sont plus claires et plus précises pour les options examinées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.