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

Italicizing non-literal syntax?

Offen
#1,500 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
HTML
Sterne
25.5k
Forks
4k
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Syntaxbeispiele im verlinkten modifying-document-Artikel zu prüfen und sie mit dem MDN-appendChild-Beispiel zu vergleichen. Bestimme den Umfang, in dem im gesamten Tutorial Kursivschrift auf nicht-literalische Syntax angewendet werden soll, dokumentiere anschließend die Konvention und aktualisiere die relevanten Beispiele einheitlich.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.