How to handle redundancy between params doc and tutorial doc

Abierto
#20 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Empieza comparando la documentación de parámetros con la documentación del tutorial, centrándote en sus textos explicativos, ejemplos y enlaces. El trabajo estará terminado cuando el proyecto tenga un límite acordado entre ambos documentos y se haya reducido la redundancia excesiva sin hacer que los lectores del tutorial dependan de enlaces frecuentes.

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

Descripción

documentation

As I said in an earlier PR, my aim is for:

  • The parameters doc to be about what the parameters do.
  • The tutorial doc to be about what the user can do.

There will necessarily be considerable overlap, both the text and in the examples, but I'd like to avoid excessive redundancy.

I don't want the tutorial to "link out" very often. The tutorial reader is entitled to have the relevant material in-line, not linked to.

I'm thinking about having the parameters doc retain its explanatory text, but link to the specific tutorial section for examples. This would make the parameters doc much shorter -- a Good Thing in itself -- and also make the reader aware of the tutorial doc -- possibly another Good Thing.

I will value opinions.

Lenguaje dominante
Ruby
Estrellas
71
Forks
27
Merge medio
3 h 3 min
PR fusionados (30 d)
2

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ruby/optparse

Todos los issues de ruby/optparse

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.