some small documentation changes

2026-03-23 23:17:44 -06:00
parent a15da2a2a1
commit 528e4a3769
3 changed files with 13 additions and 20 deletions
@@ -178,7 +178,7 @@ You can also specify Amsterdam's configuration file by using the `-C` or `--conf
 or with the `AMSTERDAM_CONFIG` environment variable.

 The exact format of the configuration file is shown in the `config/default.yaml` file. When creating an Amsterdam
-configuration file, you do not have to specify options for which you do not with to change the default.
+configuration file, you do not have to specify options for which you do not wish to change the default.

 ## Initial Login

@@ -120,7 +120,7 @@ state are saved in a temporary buffer before being written to the main output bu
 after having been modified by a rewriter.

 The `context.Context` value passed to **AmNewHTMLChecker** is checked on every iteration of the main parse loop. If
-it returns an error, the parser is stopped, allowing the HTML checker to respect external timeouts.  (The value is
+it signals "done," the parser is stopped, allowing the HTML checker to respect external timeouts.  (The value is
 stored in the HTML Checker itself, which is generally frowned upon, but used in this case to simplify the external
 API since HTML Checker objects are typically scoped to a single request.)

@@ -24,24 +24,17 @@ The character set was defined starting with the list of characters allowable in
 defined in [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986.txt), section 3.3, page 23), minus the percent-encoded
 forms, so that Amsterdam identifiers would be usable as "path information" in a URL.

-The ampersand (&) was excluded because of its possible confusion with a URL parameter separator, and because it requires HTML escaping.
+From here, various characters were excluded:

-The at sign (@) was excluded because of possible confusion with E-mail addresses and XMPP identifiers.
-
-The plus sign (+) was excluded because of possible confusion with a URL=encoded space character.
-
-The comma (,) was excluded because of its possible interpretation as a separator character.
-
-The equals sign (=) was excluded because of its possible confusion with a URL parameter/value separator.
-
-The semicolon (;) was excluded because of its possible interpretation as a separator character.
-
-The colon (:) was withheld to provide for a possible future "namespace" expansion (as in XML namespaces).
-
-The parentheses ((, )) were excluded because of possible confusion with user link syntax in conferencing.
-
-The period (.) was excluded because of possible confusion with post link syntax in conferencing.
-
-The exclamation point (!) was excluded because of possible confusion with extended post link syntax in conferencing.
+* The ampersand (&) was excluded because of its possible confusion with a URL parameter separator, and because it requires HTML escaping.
+* The at sign (@) was excluded because of possible confusion with E-mail addresses and XMPP identifiers.
+* The plus sign (+) was excluded because of possible confusion with a URL-encoded space character.
+* The comma (,) was excluded because of its possible interpretation as a separator character.
+* The equals sign (=) was excluded because of its possible confusion with a URL parameter/value separator.
+* The semicolon (;) was excluded because of its possible interpretation as a separator character.
+* The colon (:) was withheld to provide for a possible future "namespace" expansion (as in XML namespaces).
+* The parentheses ((, )) were excluded because of possible confusion with user link syntax in conferencing.
+* The period (.) was excluded because of possible confusion with post link syntax in conferencing.
+* The exclamation point (!) was excluded because of possible confusion with extended post link syntax in conferencing.

 The definition of Amsterdam identifiers was taken almost directly from the definition of Venice identifiers in the predecessor project.