mirror of https://github.com/FabricMC/yarn.git
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>
This commit is contained in:
parent
4a38df5fed
commit
012d0ebd24
|
@ -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.
|
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
|
## Mojang names
|
||||||
|
|
||||||
**Do not use names from Mojang's obfuscation maps.**
|
**Do not use names from Mojang's obfuscation maps.**
|
||||||
|
|
Loading…
Reference in New Issue