Add an explicit requirement to capitalize Tarantool #2800
Merged
Conversation
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
github-actions
bot
temporarily deployed
to
branch-tarantool-capitalization-guideline
Totktonada
reviewed
Apr 11, 2022
| ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The word "Tarantool" is capitalized because it's a product name. | ||
| The only context where it can start with a lowercase "t" is code. |
There was a problem hiding this comment.
Technically it makes legal to use the lowercased variant in a comment in the code. I would say, when a shell commmand / executable assumed.
There was a problem hiding this comment.
If the comment becomes part of the documentation (say, via ldoc), then this rule is applied. Comments that don't end up in the documentation are covered by the code style guide, not by this guide.
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.
We have a "Writing about code" section, but the user may not be sure when to consult it. This is an important product-related requirement, so I decided to make it explicit and provide a link to the section.