Clarify acronym capitalization rules in declaration names#4678
Merged
daniCsorbaJB merged 2 commits intomasterfrom Jan 30, 2025
Merged
Clarify acronym capitalization rules in declaration names#4678daniCsorbaJB merged 2 commits intomasterfrom
daniCsorbaJB merged 2 commits intomasterfrom
Conversation
AlejandraPedroza
approved these changes
Jan 30, 2025
Contributor
AlejandraPedroza
left a comment
AlejandraPedroza
left a comment
There was a problem hiding this comment.
Overall is clearer! I left a suggestion to make the two cases easier to find.
docs/topics/coding-conventions.md
Outdated
|
|
||
| When using an acronym as part of a declaration name, capitalize it if it consists of two letters (`IOStream`); | ||
| capitalize only the first letter if it is longer (`XmlFormatter`, `HttpInputStream`). | ||
| When using an acronym as part of a declaration name, write two-letter acronyms in uppercase, such as `IOStream`. |
Contributor
There was a problem hiding this comment.
Overall it's clear. We can use parallelism (considering we're comparing 2 cases) to make it easier to read and scan. For example:
When using an acronym as part of a declaration name, follow these rules:
-
For two-letter acronyms, use uppercase for both letters. For example,
IOStream. -
For acronyms longer than two letters, capitalize only the first letter. For example,
XmlFormatterorHttpInputStream.
This is a suggestion, feel free to adjust it according to your perspective.
Contributor
Author
There was a problem hiding this comment.
I like it - let's go with your version! 👍
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This update is related to issue asking to clarify capitalization rules for declaration names with acronyms KT-74339