Indexing needs improvement throughout

Abierto
#131 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

No file or test is named. Start by locating the book's index source and existing uses of the tags, then review how concepts, code terms, capitalization, and acronyms are currently indexed. Done means the index follows all four stated rules throughout the book.

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

Descripción

Indices should:

  1. Serve as a reference for all important concepts and code terminology.
  2. All code such as while should be placed in the index as <idx><c>while</c></idx>. Of course, you cannot see anything that is between <idx> tags, so indexing is best done at the beginning of a sentence or paragraph.
  3. ONLY be capitalized if a proper noun or an acronym or code that must be capitalized. e.g. object-oriented programming should NOT be capitalized in the index
  4. Acronyms should appear in the index separately from what they stand for. e.g., OOP and object-oriented programming should be indexed separately.
Lenguaje dominante
Python
Estrellas
28
Forks
42
Sin PR fusionados en 30 d

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 RunestoneInteractive/java4python

Todos los issues de RunestoneInteractive/java4python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.