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

Italicizing non-literal syntax?

未關閉
#1,500 4 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
HTML
星號
25.5k
分支
4k
PR 合併指標
30 天內沒有已合併 PR

描述

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.

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

先檢閱連結的 modifying-document 文章中的語法範例,並將其與 MDN appendChild 範例進行比較。確定在整個教學中對非字面語法套用斜體的範圍,接著記錄這項慣例,並一致地更新相關範例。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
javascript
領域
documentation
Issue 類型
文件
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。