Skip to content

Contributor docs: add guideline for literal code snippets and overlong entry points #1761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2024
Merged

Contributor docs: add guideline for literal code snippets and overlong entry points #1761

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,15 @@ Follow the general writing guidelines in this section, but see the [word and phr
* Enclose literal code, such as CSS property names, interface and method names, or other syntax, in backticks.
For example, prefer ```The `addEventListener()` method…``` and avoid ```The addEventListener() method…```.

* To aid search, include literal text that a web developer would inevitably type if they were to invoke the feature.
If there's no essential entry point to the feature, then include only concise snippets of essential literal code instead.
Never use made-up, idiosyncratic, or non-literal example code.

* 👍 Recommended: `display: flex`, `fetch()`, etc.
* 👎 Not recommended: `(await navigator.serviceWorker.ready).sync`
* 👍 Recommended: "`margin-top`, `margin-right`, `margin-bottom`, and `margin-left`"
* 👎 Not recommended: `margin-{top,right,bottom,left}`

* Start descriptions with words that are distinct to the feature.
For example, prefer "The `some-prop` CSS property…" and avoid "The CSS property `some-prop`…."

Expand Down