From 012d0ebd24fd006979cd4af257c3fa5b9320cd6e Mon Sep 17 00:00:00 2001 From: haykam821 <24855774+haykam821@users.noreply.github.com> Date: Sat, 17 Apr 2021 12:14:15 -0400 Subject: [PATCH] Add conventions for game content capitalization in documentation (#2325) * Add conventions for game content capitalization in documentation * Use sentence case for the header of the game content capitalization section Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> --- CONVENTIONS.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONVENTIONS.md b/CONVENTIONS.md index 264b2ea64d..84232b2af5 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -122,6 +122,18 @@ Write quick descriptions for parameter javadocs as well as `@return` tags, with Use `@link`, `@linkplain` and `@see` tags to refer to other parts of the code. +### Game content capitalization + +When describing content in the game itself, do not use capitalization. For example, the following is incorrect: + +> The quick Snow Fox jumped over the tamed Wolf. + +The following is acceptable: + +> The quick snow fox jumped over the tamed wolf. + +In order to hint that the description references the game's content, inline links may be used. + ## Mojang names **Do not use names from Mojang's obfuscation maps.**