Skip to content

Commit

Permalink
Fix false positives in codespell CI and fix reported typos
Browse files Browse the repository at this point in the history
- Don't install codespell when building offline docs
  as it's not needed in that workflow.
  • Loading branch information
Calinou committed May 31, 2024
1 parent 6e6b257 commit 06bd5b3
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 9 deletions.
1 change: 0 additions & 1 deletion .github/workflows/build_offline_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ jobs:
- name: Install dependencies
run: |
sudo pip3 install -r requirements.txt
sudo pip3 install codespell
sudo apt update
sudo apt install parallel libwebp7
Expand Down
2 changes: 2 additions & 0 deletions _tools/codespell-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ raison
uint
implementors
thirdparty
inout
findn
4 changes: 2 additions & 2 deletions contributing/development/compiling/compiling_for_linuxbsd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ There are two solutions:
- Follow `these instructions <https://github.com/ivmai/libatomic_ops#installation-and-usage>`__ to configure, build, and
install ``libatomic_ops``. Then, copy ``/usr/lib/libatomic_ops.a`` to ``/usr/lib/libatomic.a``, or create a soft link
to ``libatomic_ops`` by command ``ln -s /usr/lib/libatomic_ops.a /usr/lib/libatomic.a``. The soft link can ensure the
latest ``libatomic_ops`` will be used without the need to copy it everytime when it is updated.
latest ``libatomic_ops`` will be used without the need to copy it every time when it is updated.

Using mold for faster development
---------------------------------
Expand All @@ -406,7 +406,7 @@ As of January 2023, mold is not readily available in Linux distribution
repositories, so you will have to install its binaries manually.

- Download mold binaries from its `releases page <https://github.com/rui314/mold/releases/latest>`__.
- Extract the ``.tar.gz`` file, then move the extraced folder to a location such as ``.local/share/mold``.
- Extract the ``.tar.gz`` file, then move the extracted folder to a location such as ``.local/share/mold``.
- Add ``$HOME/.local/share/mold/bin`` to your user's ``PATH`` environment variable.
For example, you can add the following line at the end of your ``$HOME/.bash_profile`` file:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The tutorial will assume from now on that you placed the source code in

For Windows Defender, hit the :kbd:`Windows` key, type "Windows Security"
then hit :kbd:`Enter`. Click on **Virus & threat protection** on the left
panel. Under **Virus & threat protection settings** click on **Mange Settings**
panel. Under **Virus & threat protection settings** click on **Manage Settings**
and scroll down to **Exclusions**. Click **Add or remove exclusions** then
add the Godot source folder.

Expand Down
2 changes: 1 addition & 1 deletion contributing/development/compiling/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ setup compiling the engine for your current platform should be as easy as runnin

But you will probably need to use at least some of the available options to configure
the build to match your specific needs, be it a custom engine fork, a lightweight build
stripped of extra modules, or an executable targetting engine development.
stripped of extra modules, or an executable targeting engine development.

The articles below should help you navigate configuration options available, as well as
prerequisites required to compile Godot exactly the way you need.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ For the folders accelerated by this option, multiple ``.cpp`` files are
compiled in each translation unit, so headers can be shared between multiple
files, which can dramatically decrease build times.

To peform an SCU build, use the ``scu_build=yes`` SCons option.
To perform an SCU build, use the ``scu_build=yes`` SCons option.

.. note:: When developing a Pull Request using SCU builds, be sure to make a
regular build prior to submitting the PR. This is because SCU builds
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Annotation guidelines
compilation details because these are often inconsistent between annotations
Create annotations for modifiers that act on the script or its code.
Addionally, create annotations for behavior that is specific to the Godot
Additionally, create annotations for behavior that is specific to the Godot
engine and editor; if the primary purpose is to affect the way that the engine
or editor treats or interacts with the script, implement the token as an
annotation.
Expand Down
2 changes: 1 addition & 1 deletion tutorials/3d/global_illumination/using_lightmap_gi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ but doing so will increase bake times significantly.

To combat noise without increasing bake times too much, a denoiser can be used.
A denoiser is an algorithm that runs on the final baked lightmap, detects patterns of
noise and softens them while attempting to best preseve detail.
noise and softens them while attempting to best preserve detail.
Godot offers two denoising algorithms:

JNLM (Non-Local Means with Joint Filtering)
Expand Down
2 changes: 1 addition & 1 deletion tutorials/plugins/editor/inspector_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ You can display your custom widget in two ways. Use just the default ``add_child
method to display it to the right of the property name, and use ``add_child()``
followed by ``set_bottom_editor()`` to position it below the name.

.. FIXME: The second tab has the C# lexer for hightlighting disabled for now, as the provided code causes errors.
.. FIXME: The second tab has the C# lexer for highlighting disabled for now, as the provided code causes errors.
.. tabs::
.. code-tab:: gdscript GDScript
Expand Down

0 comments on commit 06bd5b3

Please sign in to comment.