javascript-tutorial / javascript-tutorial/en.javascript.info
Italicizing non-literal syntax?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- HTML
- Estrellas
- 25.5k
- Forks
- 4k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
How about, when showing syntax like:
node.append(...nodes or strings) – append nodes or strings at the end of node,
node.prepend(...nodes or strings) – insert nodes or strings into the beginning of node,
that "node" (in this case), or whatever syntax is not literal, that is, that stands for some general type of thing, be put in italics, i.e., in this case, to have instead:
_node_.append(...nodes or strings) – append nodes or strings at the end of node,
_node_.prepend(...nodes or strings) – insert nodes or strings into the beginning of node,
(From: [https://javascript.info/modifying-document](url))
I think that would make the meaning of the syntax clearer. Also, this is what MDN does in their Syntax descriptions, e.g.:
_element_.appendChild(aChild);
[https://developer.mozilla.org/en-US/docs/Web/API/Node/appendChild](url)
This would also address some of my earlier concerns with the use of "str", "array", "obj", etc. from a couple months ago.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando los ejemplos de sintaxis del artículo enlazado modifying-document y compáralos con el ejemplo de MDN appendChild. Determina el alcance de la aplicación de cursiva a la sintaxis no literal en todo el tutorial, documenta la convención y actualiza los ejemplos relevantes de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100