Skip to content

Add an explicit requirement to capitalize Tarantool #2800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2022
Merged

Add an explicit requirement to capitalize Tarantool #2800

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/contributing/docs/style.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,14 @@ For this reason, it's best to avoid using them.
Spelling and punctuation
------------------------

Tarantool capitalization
~~~~~~~~~~~~~~~~~~~~~~~~

The word "Tarantool" is capitalized because it's a product name.
The only context where it can start with a lowercase "t" is code.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically it makes legal to use the lowercased variant in a comment in the code. I would say, when a shell commmand / executable assumed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Learn more about :doc:`code formatting in Tarantool documentation </contributing/docs/markup/code>`.


US vs British spelling
~~~~~~~~~~~~~~~~~~~~~~

Expand Down