Skip to content

Commit e8b7a3e

Browse files
committed
Fix/exclude typos
1 parent f9c02a9 commit e8b7a3e

File tree

5 files changed

+16
-8
lines changed

5 files changed

+16
-8
lines changed

.typos.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ extend-exclude = [
66
[default]
77
locale = "en-us"
88

9+
# These are needed for the Adventure documentation
10+
extend-ignore-words-re = [
11+
"`colour`",
12+
"`grey`",
13+
"`dark_grey`",
14+
"JuliGames(Core)?"
15+
]
16+
917
[default.extend-identifiers]
1018
Spectre = "Spectre" # ignore error, the vulnerability is named Spectre
1119

src/content/docs/adventure/platform/implementing.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ Most users will be here to look at information about existing platform implement
77

88
While at its core Adventure 'just' provides data structures and serializers, as the game evolves and more functionality is added there are more tunable options and platform hooks
99
necessary to produce the correct output for the applicable game version. This has led to the introduction of a variety of services that platforms can provide implementations of using
10-
Java's `ServiceLoader` mechanism. Some other behaviours are expected by convention. As there are not that many platforms that integrate with Adventure, this page is an attempt to
10+
Java's `ServiceLoader` mechanism. Some other behaviors are expected by convention. As there are not that many platforms that integrate with Adventure, this page is an attempt to
1111
cover the common points. Please don't be afraid to ask us questions, and together we can work on fleshing out this page.
1212

1313
## Services
1414

1515
### `ComponentSerializer` Services
1616

17-
Most of the serializers (Gson, legacy, etc.) have `Provider` SPI's that allow customizing the default behaviours of serializers. These are most applicable for the Gson/other JSON
17+
Most of the serializers (Gson, legacy, etc.) have `Provider` SPI's that allow customizing the default behaviors of serializers. These are most applicable for the Gson/other JSON
1818
serializers where the data structures have changed over time, but the legacy serializer's options can be worth referencing too. See the Javadoc for each serializer for more information.
1919

2020
For any `JSONComponentSerializer` subtype, we have tried to gather relevant tunable options within a single system, keyed by the game's active
@@ -44,14 +44,14 @@ callback command is requested. The platform is responsible for ensuring any exec
4444
v1 and v2). Platforms are responsible for providing the adapter that looks up the appropriate logger by name and serializes components to text.
4545

4646
This should involve performing any translations if necessary. The default behaviour of the logger is to serialize to plain text, but platforms may want to look at the
47-
`/serializer/ansi` serializer instead for coloured output.
47+
`/serializer/ansi` serializer instead for colored output.
4848

4949
### Boss Bars
5050

5151
Boss bars are logistically somewhat complicated. As one of the few holders of mutable state in the library, they have to re-sync any state changes to their viewers.
5252
In order to track viewers and link up to any internal state, the `BossBarImplementation.Provider` SPI allows platforms to provide their own implementation hooks per-bar.
5353

54-
## Conventional Behaviours
54+
## Conventional behaviors
5555

5656
Some behaviours are expected by platforms beyond what is explicitly required by implementing certain interfaces. These are:
5757

src/content/docs/adventure/platform/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Contents:
3636
* [ViaVersion](/adventure/platform/viaversion)
3737
* [Implementing Platforms](/adventure/platform/implementing)
3838
* [Services](/adventure/platform/implementing#services)
39-
* [Conventional Behaviours](/adventure/platform/implementing#conventional-behaviours)
39+
* [Conventional Behaviors](/adventure/platform/implementing#conventional-behaviors)
4040

4141

4242
:::note

src/content/docs/adventure/serializer/json.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The JSON serializer works similar to all others, providing the basic serialize a
1111

1212
```java
1313
// Component to text
14-
final String jsonText = JSONComponentSerializer.json().serialize(Component.text("Hello world", NamedTextColour.LIGHT_PURPLE));
14+
final String jsonText = JSONComponentSerializer.json().serialize(Component.text("Hello world", NamedTextColor.LIGHT_PURPLE));
1515

1616
// JSON string to component
1717
final Component comp = JSONComponentSerializer.json().deserialize(jsonText);

src/content/docs/adventure/text.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Components represent Minecraft chat components
88
## Creating components
99

1010
```java
11-
// Creates a line of text saying "You're a Bunny! Press <key> to jump!", with some colouring and styling.
11+
// Creates a line of text saying "You're a Bunny! Press <key> to jump!", with some coloring and styling.
1212
final TextComponent textComponent = Component.text("You're a ")
1313
.color(TextColor.color(0x443344))
1414
.append(Component.text("Bunny", NamedTextColor.LIGHT_PURPLE))
@@ -26,7 +26,7 @@ You can also use a builder, which is mutable, and creates one final
2626
component with the children.
2727

2828
```java
29-
// Creates a line of text saying "You're a Bunny! Press <key> to jump!", with some colouring and styling.
29+
// Creates a line of text saying "You're a Bunny! Press <key> to jump!", with some coloring and styling.
3030
final TextComponent textComponent2 = Component.text()
3131
.content("You're a ")
3232
.color(TextColor.color(0x443344))

0 commit comments

Comments
 (0)