From 615e0d29d1a7798406d00598d29c547be21a2656 Mon Sep 17 00:00:00 2001 From: "(Jip) Willem Wijnia" Date: Tue, 16 Jul 2024 14:36:02 +0200 Subject: [PATCH] Add a workflow to check for spelling (#6353) --- .github/workflows/docs-spelling-check.yaml | 4 ++-- docs/deployment.md | 2 +- docs/development-start-here/lua-debugger.md | 1 + docs/development-start-here/lua-setup.md | 1 + docs/development-start-here/lua-syntax.md | 4 ++-- 5 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs-spelling-check.yaml b/.github/workflows/docs-spelling-check.yaml index f5533571e6..5565b9c180 100644 --- a/.github/workflows/docs-spelling-check.yaml +++ b/.github/workflows/docs-spelling-check.yaml @@ -28,8 +28,6 @@ on: pull_request: paths: ["docs/**"] - workflow_dispatch: - jobs: verify: name: Verify spelling @@ -45,4 +43,6 @@ jobs: uses: check-spelling/check-spelling@main with: checkout: false + experimental_path: docs + only_check_changed_files: true \ No newline at end of file diff --git a/docs/deployment.md b/docs/deployment.md index b566a0a50f..a578d8a99e 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -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. diff --git a/docs/development-start-here/lua-debugger.md b/docs/development-start-here/lua-debugger.md index f9a1c8663d..c8532c80ae 100644 --- a/docs/development-start-here/lua-debugger.md +++ b/docs/development-start-here/lua-debugger.md @@ -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. + diff --git a/docs/development-start-here/lua-setup.md b/docs/development-start-here/lua-setup.md index 6fb5af8f5a..baaae4ac13 100644 --- a/docs/development-start-here/lua-setup.md +++ b/docs/development-start-here/lua-setup.md @@ -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. + diff --git a/docs/development-start-here/lua-syntax.md b/docs/development-start-here/lua-syntax.md index 25f5c0b120..a74372950b 100644 --- a/docs/development-start-here/lua-syntax.md +++ b/docs/development-start-here/lua-syntax.md @@ -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. @@ -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. \ No newline at end of file +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.