javascript-tutorial / javascript-tutorial/en.javascript.info

Italicizing non-literal syntax?

Aperta
#1,500 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
HTML
Stelle
25.5k
Fork
4k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando gli esempi di sintassi nell’articolo collegato modifying-document e confrontali con l’esempio MDN appendChild. Determina l’ambito di applicazione del corsivo alla sintassi non letterale in tutto il tutorial, quindi documenta la convenzione e aggiorna coerentemente gli esempi pertinenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.