Use definition lists for glossary?

Abierto
  • ¿Algo no está bien?
#2,802 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 17 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
28/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
html, markdown
Área
documentation

Línea de trabajo

Localiza la fuente del glosario e inspecciona el procesador de Markdown o la configuración del repositorio para determinar si se admite la sintaxis de listas de definiciones. Compara el marcado actual con la forma propuesta

/
/
y verifica los enlaces y anclajes generados; se considera terminado cuando haya una decisión documentada y, si se acepta, una conversión coherente del glosario.

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

Descripción

Perhaps this is somewhat pedantic, but I wonder whether we should be move from an unordered list of terms to a definition list for the glossary?

This would be more semantically correct and would allow us to avoid manual hard breaks in our current source text, e.g.:

- allocate:\
  Dynamic memory allocation on [the heap](memory-management/review.md).
- argument:\
  Information that is passed into a function or method.
- associated type:\
  A type associated with a specific trait. Useful for defining the relationship
  between types.

Unfortunately, it looks as though current markdown processor does not support the extended syntax for dl, dt and dd tags.

That would mean that we would be required to hand-write HTML:

<dl>
  <dt>allocate</dt>
  <dd>Dynamic memory allocation on <a href="memory-management/review.html">the heap</a>.</dd>

  <dt>argument</dt>
  <dd>Information that is passed into a function or method.</dd>
  
  <dt>associated type</dt>
  <dd>A type associated with a specific trait. Useful for defining the relationship between types.</dd>

…which would unlock the ability to refer to the glossary from other parts of the course.

  <dt id="allocate">allocate</dt>
  <dd>Dynamic memory allocation on <a href="memory-management/review.html">the heap</a>.</dd>
Lenguaje dominante
Rust
Estrellas
33.5k
Forks
2.1k
Merge medio
16 d 20 h
PR fusionados (30 d)
1

Preparar el entorno

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 google/comprehensive-rust

Todos los issues de google/comprehensive-rust

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.