Skip to content

Commit

Permalink
Add a workflow to check for spelling (#6353)
Browse files Browse the repository at this point in the history
  • Loading branch information
Garanas authored Jul 16, 2024
1 parent de3b5d0 commit 615e0d2
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs-spelling-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ on:
pull_request:
paths: ["docs/**"]

workflow_dispatch:

jobs:
verify:
name: Verify spelling
Expand All @@ -45,4 +43,6 @@ jobs:
uses: check-spelling/check-spelling@main
with:
checkout: false
experimental_path: docs
only_check_changed_files: true

2 changes: 1 addition & 1 deletion docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ All three branches originate from the `develop` branch, which is the default bra

## Deployment procedures for the FAF game type

The following (manual) steps are relevant to create a valid deployment to the FAF game type.
The following (manual) stepz are relevant to create a valid deployment to the FAF game type.

- (1) Update the game version in [mod_info.lua](https://github.com/FAForever/fa/blob/c36404675c7a95cda20fe867d78bd1c01c7df103/mod_info.lua) and [version.lua](https://github.com/FAForever/fa/blob/c36404675c7a95cda20fe867d78bd1c01c7df103/lua/version.lua).
- (2) Update the game executable. This needs to be done by a server administrator. This is only required when there are changes to the executable.
Expand Down
1 change: 1 addition & 0 deletions docs/development-start-here/lua-debugger.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,4 @@ Similar to the locals tab, except that it represents the values that are accessi
- The debugger can be 'offscreen', if that is the case then you can reset its coordinates in the preference file. Backup your preference file before editing it manually. Removing the `Windows` entry is sufficient.

We highly suggest reading [The implementation of Lua 5.0](https://www.lua.org/doc/jucs05.pdf) for a deeper understanding. In particular chapter 5 is useful to read to better understand the debugger window.

1 change: 1 addition & 0 deletions docs/development-start-here/lua-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,4 @@ $RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_dev.lua /showlog /
```

Now you can start the game by executing the batch/bash script file. If all is good then the game starts as usual and you'll be in the main menu. If something is off then the game usually does not start. In that case you likely made a typo.

4 changes: 2 additions & 2 deletions docs/development-start-here/lua-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ One useful exception is the following statement.

And another useful exception is the following syntax:

- The `{h&a&}` is new syntax to create a table with a pre-allocated hash and array sections. The value `h` pre-allocates `math.pow(2, h)` entries in the hash section of a table. The value `a` pre-allocates `a` entries in the array section of a table.
- The `{h&a&}` is new syntax to create a table with a pre-allocated hash and array sections. The value `h` pre-allocates `math.pow(2, h)` entries in the hash section of a table. The value `a` pre-allocates `a` entries in the array section of a table.

It is for example applied in [#4539](https://github.com/FAForever/fa/issues/4539) to significantly improve the performance of the game.

Expand All @@ -37,4 +37,4 @@ Due to safety concerns various modules and/or functions that are part of the def

## Tips and tricks

In general the white paper '[The Implementation of Lua 5.0](https://www.lua.org/doc/jucs05.pdf)' is a great introduction on understanding the Lua interpreter of Supreme Commander: Forged Alliance.
In general the white paper '[The Implementation of Lua 5.0](https://www.lua.org/doc/jucs05.pdf)' is a great introduction on understanding the Lua interpreter of Supreme Commander: Forged Alliance.

0 comments on commit 615e0d2

Please sign in to comment.