Wording change: Dedupe dictionary member type and default definitions #526
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
inexorabletash
force-pushed
the
wording-dict-defn-dedupe
branch
from
d23c45b to
32629ce
Compare
|
I don't feel strongly about this - in particular the convention is unique to this spec, so far as I can tell. Being consistent means it'll be easy to update later. |
|
More concise, I prefer it this way. |
inexorabletash
force-pushed
the
wording-dict-defn-dedupe
branch
from
32629ce to
96365f3
Compare
huningxin
approved these changes
Feb 4, 2024
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 webmachinelearning#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.
inexorabletash
force-pushed
the
wording-dict-defn-dedupe
branch
from
d643d3e to
1a340fd
Compare
huningxin
approved these changes
Feb 5, 2024
anssiko
approved these changes
Feb 5, 2024
|
I feel like this is a strict improvement. Also good to see SpecCodingConventions.md maintained. Thanks @inexorabletash! Merging this wording change PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
*[ ... ]*styling.This probably merits some discussion, so uploading early for comments.
Preview | Diff