Skip to content

Commit 32629ce

Browse files
Wording change: Dedupe dictionary member type and default definitions
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.
1 parent fa91851 commit 32629ce

File tree

2 files changed

+108
-145
lines changed

2 files changed

+108
-145
lines changed

SpecCodingConventions.md

+1
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Example:
7676
* 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.
7777
* 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.
7878
* Strings used internally (e.g. operator names) should not be styled as code.
79+
* 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]*_)
7980

8081

8182
### Algorithms

0 commit comments

Comments
 (0)