atom-community / atom-community/ide-python

Improve feature provider option descriptions

Abierto
#98 4 comentarios 1 reacción 0 asignados Ver en GitHub
documentation good first issue
Lenguaje dominante
JavaScript
Estrellas
238
Forks
40
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con las descripciones de las opciones de los plugins en package.json, especialmente las líneas 67-350, y compara cada entrada con la documentación de su proveedor de funcionalidades específico. Actualiza las descripciones o añade enlaces relevantes a la documentación cuando sean inexactas o demasiado básicas. Se considerará completado cuando las descripciones de la configuración de Atom sean más claras y precisas para las opciones revisadas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.