Editorial: Linkify all argument/option references outside algorithms

Part of webmachinelearning#783
inexorabletash · Dec 7, 2024 · 9342202 · 9342202
1 parent 8d41d22
commit 9342202
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 34 deletions.
diff --git a/docs/SpecCodingConventions.md b/docs/SpecCodingConventions.md
@@ -97,6 +97,7 @@ Example:
 * In Web IDL `<pre class=idl>` blocks, wrap long lines to avoid horizontal scrollbars. 88 characters seems to be the magic number.
 * Avoid `<var>v</var>` or `|v|` outside of algorithms; Bikeshed interprets these as global variables which can mask errors. Just use `*v*`.
     * Format each term separately; that is, `*splits*[*i*]` not `*splits[i]*`.
+* When referencing an argument in prose steps, link to it rather than just using formatted text e.g. `{{MLGraphBuilder/split(input, splits*, options)/splits}}` rather than `*splits*`.
 
 
 ### Algorithms