Skip to content

Commit

Permalink
Fix missing spaces in docs (#49)
Browse files Browse the repository at this point in the history 
Add spaces before a few Examples, and align table columns.
  • Loading branch information
@ador
ador committed Nov 23, 2023
1 parent 5be2d17 commit bdf3518
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 17 deletions.
14 changes: 7 additions & 7 deletions docs/api/objects/board.md
View file
Expand Up @@ -30,10 +30,10 @@ The game board is represented by a standard 2D grid, oriented with (0,0) in the
}
```

| **Property** | **Type** | **Description** |
| ------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **height** | integer | The number of rows in the y-axis of the game board.<em>Example: 11</em> |
| **width** | integer | The number of columns in the x-axis of the game board.<em>Example: 11</em> |
| **food** | array | Array of coordinates representing food locations on the game board.<em>Example: [{"x": 5, "y": 5}, ..., {"x": 2, "y": 6}]</em> |
| **hazards** | array | Array of coordinates representing hazardous locations on the game board. These will only appear in some [game modes](guides/playing/modes.md).<em>Example: [{"x": 0, "y": 0}, ..., {"x": 0, "y": 1}]</em> |
| **snakes** | array | Array of [Battlesnake Objects](battlesnake.md) representing all Battlesnakes remaining on the game board (including yourself if you haven't been eliminated).<em>Example: [{"id": "snake-one", ...}, ...]</em> |
| **Property** | **Type** | **Description** |
| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **height** | integer | The number of rows in the y-axis of the game board. <em>Example: 11</em> |
| **width** | integer | The number of columns in the x-axis of the game board. <em>Example: 11</em> |
| **food** | array | Array of coordinates representing food locations on the game board. <em>Example: [{"x": 5, "y": 5}, ..., {"x": 2, "y": 6}]</em> |
| **hazards** | array | Array of coordinates representing hazardous locations on the game board. These will only appear in some [game modes](guides/playing/modes.md). <em>Example: [{"x": 0, "y": 0}, ..., {"x": 0, "y": 1}]</em> |
| **snakes** | array | Array of [Battlesnake Objects](battlesnake.md) representing all Battlesnakes remaining on the game board (including yourself if you haven't been eliminated). <em>Example: [{"id": "snake-one", ...}, ...]</em> |
6 changes: 3 additions & 3 deletions docs/api/objects/game.md
View file
Expand Up @@ -20,8 +20,8 @@ sidebar_position: 1

| **Property** | **Type** | **Description** |
| ------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | string | A unique identifier for this Game.<em>Example: "totally-unique-game-id"</em> |
| **ruleset** | object | Information about the ruleset being used to run this game.<em>Example: {"name": "standard", "version": "v1.2.3"}</em> |
| **id** | string | A unique identifier for this Game. <em>Example: "totally-unique-game-id"</em> |
| **ruleset** | object | Information about the ruleset being used to run this game. <em>Example: {"name": "standard", "version": "v1.2.3"}</em> |
| **map** | string | The name of the map used to populate the game board with snakes, food, and hazards. <em>Example: "standard"</em> See [Game Maps](game-maps.md) |
| **timeout** | integer _(milliseconds)_ | How much time your snake has to respond to requests for this Game.<em>Example: 500</em> |
| **timeout** | integer _(milliseconds)_ | How much time your snake has to respond to requests for this Game. <em>Example: 500</em> |
| **source** | string | The source of this game. One of:<ul><li>tournament</li><li>league <em>(for League Arenas)</em></li><li>arena <em>(for all other Arenas)</em></li><li>challenge</li><li>custom <em>(for all other games sources)</em></li></ul>The values for this field may change in the near future. |
2 changes: 1 addition & 1 deletion docs/api/objects/ruleset.md
View file
Expand Up @@ -14,6 +14,6 @@ sidebar_position: 2

| **Property** | **Type** | **Description** |
| ------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **name** | string | Name of the ruleset being used to run this game. Possible values include: standard, solo, royale, squad, constrictor, wrapped. See [Game Modes](../../guides/playing/modes.md) for more information on each ruleset.<em>Example: "standard"</em> |
| **name** | string | Name of the ruleset being used to run this game. Possible values include: standard, solo, royale, squad, constrictor, wrapped. See [Game Modes](../../guides/playing/modes.md) for more information on each ruleset. <em>Example: "standard"</em> |
| **version** | string | The release version of the [Rules](https://github.com/BattlesnakeOfficial/rules) module used in this game. <em>Example: "version": "v1.2.3"</em> |
| **settings** | object | A collection of [specific settings](ruleset-settings.md) being used by the current game that control how the rules are applied. |
8 changes: 4 additions & 4 deletions docs/api/requests/info.md
View file
Expand Up @@ -30,10 +30,10 @@ An empty GET request made to the top-level URL of your Battlesnake, used for cus
| **Parameter** | **Type** | **Description** |
| -------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **apiversion** | string _(required)_ | Version of the Battlesnake API implemented by this Battlesnake. Currently only API version 1 is valid. <em>Example: "1"</em> |
| **author** | string _(optional)_ | Username of the author of this Battlesnake. If provided, this will be used to verify ownership.<em>Example: "BattlesnakeOfficial"</em> |
| **color** | string _(optional)_ | Hex color code used to display this Battlesnake. Must start with "#" and be 7 characters long.<em>Example: "#888888"</em> |
| **head** | string _(optional)_ | Displayed head of this Battlesnake. See [Customization Guide](guides/customizations.md) for available options<em>Example: "default"</em> |
| **tail** | string _(optional)_ | Displayed tail of this Battlesnake. See [Customization Guide](guides/customizations.md) for available options.<em>Example: "default"</em> |
| **author** | string _(optional)_ | Username of the author of this Battlesnake. If provided, this will be used to verify ownership. <em>Example: "BattlesnakeOfficial"</em> |
| **color** | string _(optional)_ | Hex color code used to display this Battlesnake. Must start with "#" and be 7 characters long. <em>Example: "#888888"</em> |
| **head** | string _(optional)_ | Displayed head of this Battlesnake. See [Customization Guide](guides/customizations.md) for available options. <em>Example: "default"</em> |
| **tail** | string _(optional)_ | Displayed tail of this Battlesnake. See [Customization Guide](guides/customizations.md) for available options. <em>Example: "default"</em> |
| **version** | string _(optional)_ | A version number or tag for your snake. |

See [Customization Guide](guides/customizations.md) for available colors, heads, and tails.
4 changes: 2 additions & 2 deletions docs/api/requests/move.md
View file
Expand Up @@ -32,5 +32,5 @@ This request will be sent for every turn of the game. Use the information provid

| **Parameter** | **Type** | **Description** |
| ------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| **move** | string | Your Battlesnake's move for this turn. Valid moves are up, down, left, or right.<em>Example: "up"</em> |
| **shout** | string _(optional)_ | An optional message sent to all other Battlesnakes on the next turn. Must be 256 characters or less.<em>Example: "I am moving up!"</em>< |
| **move** | string | Your Battlesnake's move for this turn. Valid moves are up, down, left, or right. <em>Example: "up"</em> |
| **shout** | string _(optional)_ | An optional message sent to all other Battlesnakes on the next turn. Must be 256 characters or less. <em>Example: "I am moving up!"</em> |

0 comments on commit bdf3518

Please sign in to comment.