From a803be19a65f96915d11ef7ae7bd017ce2b39689 Mon Sep 17 00:00:00 2001 From: Anne van Kesteren Date: Wed, 27 Sep 2023 14:47:23 +0200 Subject: [PATCH] nit --- README.md | 56 ++++++++++++++++--------------------------------------- 1 file changed, 16 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 8401d06..5eb9305 100644 --- a/README.md +++ b/README.md @@ -83,53 +83,29 @@ is. End tags may be included (if done consistently) and attributes may be quoted (using double quotes), though the prevalent theme is to omit end tags and not quote attributes (unless they contain a space). -## Formatting +Place one newline between paragraphs (including list elements). Place three newlines before `

`, and two newlines before other headings. This does not apply when a nested heading follows the parent heading. +```html + -Do not use newlines inside "inline" elements, even if that means exceeding the column width requirement. -```html -

The -remove(tokens…) -method, when invoked, must run these steps: -``` -is okay and - ```html -

The remove(tokens…) method, when -invoked, must run these steps: -``` -is not. +

Place a newline above. -Using newlines between "inline" element tag names and their content is also forbidden. (This actually alters the content, by adding spaces.) That is -```html -token -``` -is fine and -```html -token - -``` -is not. -An `

  • ` element always has a `

    ` element inside it, unless it's a child of `

      `. +

      Place two newlines above.

      -If a "block" element contains a single "block" element, do not put it on a newline. +

      Placing one newline is OK here.

      -Do not indent for anything except a new "block" element. For instance + +

      Place two newlines above.

      +``` +Use camel-case for variable names and "spaced" names for definitions, algorithms, etc. ```html -

    • For each token in tokens, in given order, that is not in - tokens, append token to tokens. +

      A request has an associated +redirect mode,... ``` -is not indented, but ```html -

        -
      1. -

        For each token in tokens, run these substeps: - -

          -

        1. If token is the empty string, throw a {{SyntaxError}} exception. +

          Let redirectMode be request's redirect mode. ``` -is. - -End tags may be included (if done consistently) and attributes may be quoted (using double quotes), though the prevalent theme is to omit end tags and not quote attributes (unless they contain a space).