Skip to content

Commit 416d78b

Browse files
zlataovceolijeffers0n
zlataovce
and
olijeffers0n
authored
chore: syntax cleanup and standardization (#343)
chore: syntax housekeeping --------- Co-authored-by: Ollie <[email protected]>
1 parent 71078fb commit 416d78b

File tree

88 files changed

+660
-650
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+660
-650
lines changed

‎.typos.toml

+6
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,24 @@ armour = "armor"
1818
authorise = "authorize"
1919
authorised = "authorized"
2020
authorising = "authorizing"
21+
behaviour = "behavior"
2122
catalogue = "catalog"
2223
centre = "center"
2324
civilisation = "civilization"
2425
civilised = "civilized"
2526
colour = "color"
2627
colours = "colors"
2728
defence = "defense"
29+
generalise = "generalize"
30+
generalised = "generalized"
2831
gramme = "gram"
2932
grammes = "grams"
3033
grey = "gray"
3134
honour = "honor"
3235
honours = "honors"
36+
initialise = "initialize"
37+
initialised = "initialized"
38+
initialiser = "initializer"
3339
kerb = "curb"
3440
kerbs = "curbs"
3541
labour = "labor"

‎CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ To maintain consistency and readability across the documentation, please adhere
7979
2. **Markdown Format**: Documentation should be written in Markdown format (.md or .mdx) for easy rendering on the website.
8080

8181
3. **Heading Structure**: Use `h1` (#) for the main title, `h2` (##) for section headings, and follow this pattern for subsequent subheadings.
82+
Capitalize the first letter of each word in a h1, however, only capitalize the first letter of the first word in h2 and h3 unless~
83+
it is a proper noun.
8284

8385
4. **Code Blocks**: When including code snippets or terminal commands, use fenced code blocks with the appropriate syntax highlighting.
8486

@@ -95,6 +97,8 @@ To maintain consistency and readability across the documentation, please adhere
9597

9698
10. **Be Inclusive**: Be mindful of all readers and contributors. Use language that is inclusive and welcoming to everyone.
9799

100+
11. **Capitalise Vanilla**: When referring to the base game, use "Vanilla" with a capital "V".
101+
98102
## Automatic Doc Versioning
99103

100104
There are components and methods in order to embed the current Project Version into the documentation. This is done one

‎config-specs/paper/bukkit.yml

+12-12
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ settings:
5151
default: update
5252
description: >-
5353
Path to replace new plugin versions with.
54-
[See Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
54+
See [Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
5555
use-map-color-cache:
5656
default: "true"
5757
description: >-
@@ -65,37 +65,37 @@ spawn-limits:
6565
default: "15"
6666
description: >-
6767
Set the spawn-limits for ambient mobs. This can be overridden by the
68-
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
68+
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
6969
animals:
7070
default: "10"
7171
description: >-
7272
Set the spawn-limits for animals. This can be overridden by the
73-
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_creature).
73+
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_creature).
7474
axolotls:
7575
default: "5"
7676
description: >-
7777
Set the spawn-limits for axolotls. This can be overridden by the
78-
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
78+
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
7979
monsters:
8080
default: "70"
8181
description: >-
8282
Set the spawn-limits for monsters. This can be overridden by the
83-
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
83+
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
8484
water-ambient:
8585
default: "20"
8686
description: >-
8787
Set the spawn-limits for water ambient mobs. This can be overridden by the
88-
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_ambient).
88+
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_ambient).
8989
water-animals:
9090
default: "5"
9191
description: >-
9292
Set the spawn-limits for water animals. This can be overridden by the
93-
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
93+
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
9494
water-underground-creature:
9595
default: "5"
9696
description: >-
9797
Set the spawn-limits for water underground creatures. This can be
98-
overridden by the [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_underground_water_creature).
98+
overridden by the [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_underground_water_creature).
9999
ticks-per:
100100
ambient-spawns:
101101
default: "1"
@@ -142,14 +142,14 @@ worlds:
142142
biome-provider:
143143
default: "N/A"
144144
description: >-
145-
The biome provider to use for this world. Plugins must register a BiomeProvider
145+
The biome provider to use for this world. Plugins must register a `BiomeProvider`
146146
to be used here. The format is *plugin-name:extra-parameters* or *plugin-name*
147147
if no extra parameters are needed. The plugin name is as defined in the
148-
plugin.yml or paper-plugin.yml.
148+
`plugin.yml` or `paper-plugin.yml`.
149149
generator:
150150
default: "N/A"
151151
description: >-
152-
The generator to use for this world. Plugins must register a ChunkGenerator
152+
The generator to use for this world. Plugins must register a `ChunkGenerator`
153153
to be used here. The format is *plugin-name:extra-parameters* or
154154
*plugin-name* if no extra parameters are needed. The plugin name is as defined
155-
in the plugin.yml or paper-plugin.yml.
155+
in the `plugin.yml` or `paper-plugin.yml`.

‎config-specs/paper/commands.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
command-block-overrides:
22
default: "[<command to override>]"
33
description: >
4-
Which vanilla commands should be prioritized over those provided by Bukkit
5-
or plugins. Useful for compatibility with adventure maps built for vanilla
4+
Which Vanilla commands should be prioritized over those provided by Bukkit
5+
or plugins. Useful for compatibility with adventure maps built for Vanilla
66
command blocks.
77
8-
Use the literal ''*'' to always use the vanilla version in command blocks.
8+
Use the literal ''*'' to always use the Vanilla version in command blocks.
99
1010
By default, no commands are overridden.
1111
ignore-vanilla-permissions:
1212
default: "false"
13-
description: Whether to use vanilla permission levels when executing commands.
13+
description: Whether to use Vanilla permission levels when executing commands.
1414
aliases:
1515
<alias name>:
1616
default: "[<commands to run>]"

‎config-specs/paper/paper-global.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ collisions:
8181
default: "true"
8282
description: >-
8383
Collisions with boats and minecarts are often subject to client/server
84-
disagreement, which may cause glitchy behaviour for players. This setting
84+
disagreement, which may cause glitchy behavior for players. This setting
8585
attempts to mitigate this desync by sending precise locations for entities
8686
involved in collisions. Having this enabled will use more bandwidth;
8787
however, in the majority of cases, this is a worthy tradeoff
@@ -225,7 +225,7 @@ misc:
225225
default: "false"
226226
description: >-
227227
Whether phantoms, wandering traders, etc. should be able to spawn in
228-
custom overworlds. Defaults to false in order to match vanilla behavior
228+
custom overworlds. Defaults to false in order to match Vanilla behavior
229229
strict-advancement-dimension-check:
230230
default: "false"
231231
description: >-
@@ -400,7 +400,7 @@ unsupported-settings:
400400
allow-permanent-block-break-exploits:
401401
default: "false"
402402
description: >-
403-
Whether unbreakable blocks can be broken with vanilla exploits. This
403+
Whether unbreakable blocks can be broken with Vanilla exploits. This
404404
includes bedrock, end portal frames, end portal blocks, and more
405405
allow-piston-duplication:
406406
default: "false"

‎config-specs/paper/paper-world-defaults.yml

+11-11
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,11 @@ collisions:
175175
command-blocks:
176176
permissions-level:
177177
default: "2"
178-
description: "Default vanilla permission level for command blocks."
178+
description: "Default Vanilla permission level for command blocks."
179179
force-follow-perm-level:
180180
default: "true"
181181
description: "Require that command blocks meet both the Bukkit permission requirements
182-
and the vanilla permission level. Otherwise, only 1 of those is required."
182+
and the Vanilla permission level. Otherwise, only 1 of those is required."
183183
entities:
184184
armor-stands:
185185
do-collision-entity-lookups:
@@ -240,13 +240,13 @@ entities:
240240
description: >-
241241
Instructs the server to allow zombies to pick up loot. If set to
242242
false, the probability that a zombie picks up items depends on the
243-
world's difficulty (vanilla behavior)
243+
world's difficulty (Vanilla behavior)
244244
skeleton:
245245
default: "false"
246246
description: >-
247247
Instructs the server to allow skeletons to pick up loot. If set to
248248
false, the probability that a skeleton picks up items depends on the
249-
world's difficulty (vanilla behavior)
249+
world's difficulty (Vanilla behavior)
250250
nerf-pigmen-from-nether-portals:
251251
default: "false"
252252
description: "Removes AI from pigmen spawned via nether portals "
@@ -429,9 +429,9 @@ entities:
429429
filtered-entity-tag-nbt-paths:
430430
default: "[Pos, Motion, SleepingX, SleepingY, SleepingZ]"
431431
description: >-
432-
A list of nbt tags that will be removed from the EntityTag tag on items
432+
A list of NBT tags that will be removed from the EntityTag tag on items
433433
which spawn entities. The format of these strings follows the same
434-
format used to select nbt tags in vanilla commands. If the spawning was
434+
format used to select NBT tags in Vanilla commands. If the spawning was
435435
directly caused by a player and the player has the minecraft.nbt.place
436436
permission, the filter list will be ignored. The defaults are set to
437437
prevent entities from spawning or moving to a place other than the
@@ -660,7 +660,7 @@ environment:
660660
default: disabled
661661
description: >-
662662
Sets the level above which players in the nether will take void damage.
663-
This is a vanilla-friendly way to restrict players from using the nether
663+
This is a Vanilla-friendly way to restrict players from using the nether
664664
ceiling as a buildable area. Setting to disabled disables this feature
665665
optimize-explosions:
666666
default: "false"
@@ -680,7 +680,7 @@ environment:
680680
portal. If it can't find one in that range, it will generate a new one
681681
portal-search-vanilla-dimension-scaling:
682682
default: "true"
683-
description: Whether to apply vanilla dimension scaling to portal-search-radius
683+
description: Whether to apply Vanilla dimension scaling to portal-search-radius
684684
treasure-maps:
685685
enabled:
686686
default: "true"
@@ -693,7 +693,7 @@ environment:
693693
description: >-
694694
Overrides the loot table-configured check for undiscovered structures.
695695
default allows loot tables to individually determine if the map should
696-
allow discovered locations in its search. All vanilla loot tables
696+
allow discovered locations in its search. All Vanilla loot tables
697697
default to skipping discovered locations so changing this to false
698698
would override that behavior and force them to search discovered
699699
locations
@@ -923,8 +923,8 @@ scoreboards:
923923
use-vanilla-world-scoreboard-name-coloring:
924924
default: "false"
925925
description: >-
926-
Instructs the server to use the vanilla scoreboard for player nickname
927-
coloring. Useful when playing on adventure maps made for the vanilla
926+
Instructs the server to use the Vanilla scoreboard for player nickname
927+
coloring. Useful when playing on adventure maps made for the Vanilla
928928
server and client
929929
spawn:
930930
allow-using-signs-inside-spawn-protection:

0 commit comments

Comments
 (0)