Skip to content

Commit

Permalink
chore: syntax cleanup and standardization (#343)
Browse files Browse the repository at this point in the history
chore: syntax housekeeping

---------

Co-authored-by: Ollie <69084614+olijeffers0n@users.noreply.github.com>
  • Loading branch information
zlataovce and olijeffers0n committed Apr 11, 2024
1 parent 71078fb commit 416d78b
Show file tree
Hide file tree
Showing 88 changed files with 660 additions and 650 deletions.
6 changes: 6 additions & 0 deletions .typos.toml
Expand Up @@ -18,18 +18,24 @@ armour = "armor"
authorise = "authorize"
authorised = "authorized"
authorising = "authorizing"
behaviour = "behavior"
catalogue = "catalog"
centre = "center"
civilisation = "civilization"
civilised = "civilized"
colour = "color"
colours = "colors"
defence = "defense"
generalise = "generalize"
generalised = "generalized"
gramme = "gram"
grammes = "grams"
grey = "gray"
honour = "honor"
honours = "honors"
initialise = "initialize"
initialised = "initialized"
initialiser = "initializer"
kerb = "curb"
kerbs = "curbs"
labour = "labor"
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -79,6 +79,8 @@ To maintain consistency and readability across the documentation, please adhere
2. **Markdown Format**: Documentation should be written in Markdown format (.md or .mdx) for easy rendering on the website.

3. **Heading Structure**: Use `h1` (#) for the main title, `h2` (##) for section headings, and follow this pattern for subsequent subheadings.
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~
it is a proper noun.

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

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

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

11. **Capitalise Vanilla**: When referring to the base game, use "Vanilla" with a capital "V".

## Automatic Doc Versioning

There are components and methods in order to embed the current Project Version into the documentation. This is done one
Expand Down
24 changes: 12 additions & 12 deletions config-specs/paper/bukkit.yml
Expand Up @@ -51,7 +51,7 @@ settings:
default: update
description: >-
Path to replace new plugin versions with.
[See Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
See [Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
use-map-color-cache:
default: "true"
description: >-
Expand All @@ -65,37 +65,37 @@ spawn-limits:
default: "15"
description: >-
Set the spawn-limits for ambient mobs. This can be overridden by the
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
animals:
default: "10"
description: >-
Set the spawn-limits for animals. This can be overridden by the
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_creature).
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_creature).
axolotls:
default: "5"
description: >-
Set the spawn-limits for axolotls. This can be overridden by the
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
monsters:
default: "70"
description: >-
Set the spawn-limits for monsters. This can be overridden by the
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
water-ambient:
default: "20"
description: >-
Set the spawn-limits for water ambient mobs. This can be overridden by the
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_ambient).
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_ambient).
water-animals:
default: "5"
description: >-
Set the spawn-limits for water animals. This can be overridden by the
[paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
[Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
water-underground-creature:
default: "5"
description: >-
Set the spawn-limits for water underground creatures. This can be
overridden by the [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_underground_water_creature).
overridden by the [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_underground_water_creature).
ticks-per:
ambient-spawns:
default: "1"
Expand Down Expand Up @@ -142,14 +142,14 @@ worlds:
biome-provider:
default: "N/A"
description: >-
The biome provider to use for this world. Plugins must register a BiomeProvider
The biome provider to use for this world. Plugins must register a `BiomeProvider`
to be used here. The format is *plugin-name:extra-parameters* or *plugin-name*
if no extra parameters are needed. The plugin name is as defined in the
plugin.yml or paper-plugin.yml.
`plugin.yml` or `paper-plugin.yml`.
generator:
default: "N/A"
description: >-
The generator to use for this world. Plugins must register a ChunkGenerator
The generator to use for this world. Plugins must register a `ChunkGenerator`
to be used here. The format is *plugin-name:extra-parameters* or
*plugin-name* if no extra parameters are needed. The plugin name is as defined
in the plugin.yml or paper-plugin.yml.
in the `plugin.yml` or `paper-plugin.yml`.
8 changes: 4 additions & 4 deletions config-specs/paper/commands.yml
@@ -1,16 +1,16 @@
command-block-overrides:
default: "[<command to override>]"
description: >
Which vanilla commands should be prioritized over those provided by Bukkit
or plugins. Useful for compatibility with adventure maps built for vanilla
Which Vanilla commands should be prioritized over those provided by Bukkit
or plugins. Useful for compatibility with adventure maps built for Vanilla
command blocks.
Use the literal ''*'' to always use the vanilla version in command blocks.
Use the literal ''*'' to always use the Vanilla version in command blocks.
By default, no commands are overridden.
ignore-vanilla-permissions:
default: "false"
description: Whether to use vanilla permission levels when executing commands.
description: Whether to use Vanilla permission levels when executing commands.
aliases:
<alias name>:
default: "[<commands to run>]"
Expand Down
6 changes: 3 additions & 3 deletions config-specs/paper/paper-global.yml
Expand Up @@ -81,7 +81,7 @@ collisions:
default: "true"
description: >-
Collisions with boats and minecarts are often subject to client/server
disagreement, which may cause glitchy behaviour for players. This setting
disagreement, which may cause glitchy behavior for players. This setting
attempts to mitigate this desync by sending precise locations for entities
involved in collisions. Having this enabled will use more bandwidth;
however, in the majority of cases, this is a worthy tradeoff
Expand Down Expand Up @@ -225,7 +225,7 @@ misc:
default: "false"
description: >-
Whether phantoms, wandering traders, etc. should be able to spawn in
custom overworlds. Defaults to false in order to match vanilla behavior
custom overworlds. Defaults to false in order to match Vanilla behavior
strict-advancement-dimension-check:
default: "false"
description: >-
Expand Down Expand Up @@ -400,7 +400,7 @@ unsupported-settings:
allow-permanent-block-break-exploits:
default: "false"
description: >-
Whether unbreakable blocks can be broken with vanilla exploits. This
Whether unbreakable blocks can be broken with Vanilla exploits. This
includes bedrock, end portal frames, end portal blocks, and more
allow-piston-duplication:
default: "false"
Expand Down
22 changes: 11 additions & 11 deletions config-specs/paper/paper-world-defaults.yml
Expand Up @@ -175,11 +175,11 @@ collisions:
command-blocks:
permissions-level:
default: "2"
description: "Default vanilla permission level for command blocks."
description: "Default Vanilla permission level for command blocks."
force-follow-perm-level:
default: "true"
description: "Require that command blocks meet both the Bukkit permission requirements
and the vanilla permission level. Otherwise, only 1 of those is required."
and the Vanilla permission level. Otherwise, only 1 of those is required."
entities:
armor-stands:
do-collision-entity-lookups:
Expand Down Expand Up @@ -240,13 +240,13 @@ entities:
description: >-
Instructs the server to allow zombies to pick up loot. If set to
false, the probability that a zombie picks up items depends on the
world's difficulty (vanilla behavior)
world's difficulty (Vanilla behavior)
skeleton:
default: "false"
description: >-
Instructs the server to allow skeletons to pick up loot. If set to
false, the probability that a skeleton picks up items depends on the
world's difficulty (vanilla behavior)
world's difficulty (Vanilla behavior)
nerf-pigmen-from-nether-portals:
default: "false"
description: "Removes AI from pigmen spawned via nether portals "
Expand Down Expand Up @@ -429,9 +429,9 @@ entities:
filtered-entity-tag-nbt-paths:
default: "[Pos, Motion, SleepingX, SleepingY, SleepingZ]"
description: >-
A list of nbt tags that will be removed from the EntityTag tag on items
A list of NBT tags that will be removed from the EntityTag tag on items
which spawn entities. The format of these strings follows the same
format used to select nbt tags in vanilla commands. If the spawning was
format used to select NBT tags in Vanilla commands. If the spawning was
directly caused by a player and the player has the minecraft.nbt.place
permission, the filter list will be ignored. The defaults are set to
prevent entities from spawning or moving to a place other than the
Expand Down Expand Up @@ -660,7 +660,7 @@ environment:
default: disabled
description: >-
Sets the level above which players in the nether will take void damage.
This is a vanilla-friendly way to restrict players from using the nether
This is a Vanilla-friendly way to restrict players from using the nether
ceiling as a buildable area. Setting to disabled disables this feature
optimize-explosions:
default: "false"
Expand All @@ -680,7 +680,7 @@ environment:
portal. If it can't find one in that range, it will generate a new one
portal-search-vanilla-dimension-scaling:
default: "true"
description: Whether to apply vanilla dimension scaling to portal-search-radius
description: Whether to apply Vanilla dimension scaling to portal-search-radius
treasure-maps:
enabled:
default: "true"
Expand All @@ -693,7 +693,7 @@ environment:
description: >-
Overrides the loot table-configured check for undiscovered structures.
default allows loot tables to individually determine if the map should
allow discovered locations in its search. All vanilla loot tables
allow discovered locations in its search. All Vanilla loot tables
default to skipping discovered locations so changing this to false
would override that behavior and force them to search discovered
locations
Expand Down Expand Up @@ -923,8 +923,8 @@ scoreboards:
use-vanilla-world-scoreboard-name-coloring:
default: "false"
description: >-
Instructs the server to use the vanilla scoreboard for player nickname
coloring. Useful when playing on adventure maps made for the vanilla
Instructs the server to use the Vanilla scoreboard for player nickname
coloring. Useful when playing on adventure maps made for the Vanilla
server and client
spawn:
allow-using-signs-inside-spawn-protection:
Expand Down

0 comments on commit 416d78b

Please sign in to comment.