Skip to content

Commit

Permalink
Wording change: Dedupe dictionary member type and default definitions
Browse files Browse the repository at this point in the history
Bikeshed automatically annotates dictionary members with types and
defaults, so repeating that in the prose is extra work and extra
noise. Remove both and reword as needed. For #483

Also:

- Simplify text by removing "Specifies" from most definition prose.
- Replace "sequence" with "list" in prose.
- Consistently give list member definitions using *[ ... *] styling.
- Document the above in coding conventions.
  • Loading branch information
inexorabletash committed Jan 27, 2024
1 parent 479ce17 commit 96365f3
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 145 deletions.
1 change: 1 addition & 0 deletions SpecCodingConventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Example:
* Bikeshed will automatically style linked terms appropriately, for example Web IDL types show up as `code`. Try to avoid manual styling wherever possible; if you're not getting the style you expect, you may have incorrect definitions or links.
* Outside of examples, which should be appropriately styled automatically, literals such as numbers within spec prose are not JavaScript values and should not be styled as code.
* Strings used internally (e.g. operator names) should not be styled as code.
* When concisely defining a list's members or a tensor's layout, use the syntax `*[ ... ]*` (e.g. _"nchw" means the input tensor has the layout *[batches, inputChannels, height, width]*_)


### Algorithms
Expand Down
Loading

0 comments on commit 96365f3

Please sign in to comment.