Clarify capitalization of abbr and acronym #5876
Merged
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
|
Visit the preview URL for this PR (updated for commit e9cc0a4): |
MaryaBelanger
added
review.tech
MaryaBelanger
approved these changes
Jun 3, 2024
src/content/effective-dart/style.md
Outdated
Comment on lines
225
to
242
| // Longer than two letters, so always like a word: | ||
| Http // "hypertext transfer protocol" | ||
| Nasa // "national aeronautics and space administration" | ||
| Uri // "uniform resource locator" | ||
| Esq // "esquire" | ||
| Ave // "avenue" | ||
|
|
||
| // Two letters, capitalized in English, so capitalized in an identifier: | ||
| ID // "identifier", capitalized as "ID" | ||
| TV // "television" | ||
| DB // "database", originally an acronym from "data base" | ||
| IO // "input/output" | ||
| UI // "user interface" | ||
|
|
||
| // Two letters, not capitalized in English, so like a word in an identifier: | ||
| Mr // "mister" | ||
| St // "street" | ||
| Rd // "road" |
There was a problem hiding this comment.
Both this (and the "bad" list lines 246-260) seem really long. I'd suggest 2-3 examples per category max
There was a problem hiding this comment.
I can trim the middle list, but the first list has 4 and 3 letter examples that are helpful.
Removed dependent clauses Co-authored-by: Marya <[email protected]>
atsansone
commented
Jun 3, 2024
src/content/effective-dart/style.md
Outdated
Comment on lines
233
to
237
| ID // "identifier", capitalized as "ID" | ||
| TV // "television" | ||
| DB // "database", originally an acronym from "data base" | ||
| IO // "input/output" | ||
| UI // "user interface" |
There was a problem hiding this comment.
issue:
Suggested change
| ID // "identifier", capitalized as "ID" | |
| TV // "television" | |
| DB // "database", originally an acronym from "data base" | |
| IO // "input/output" | |
| UI // "user interface" | |
| ID // "identifier" | |
| TV // "television" | |
| UI // "user interface" |
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.
Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below.
Fixes #4111
Contribution guidelines:
dart format.<?code-excerptneed to be updated in their source.dartfile as well.