Skip to content

Install typos GHA and fix typos #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/workflows/build-guidelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,14 @@ jobs:
path: build
retention-days: 7
compression-level: 6 # Default compression level for a good balance of speed and size
lint_rst:

check_typos:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Install typos
run: cargo install typos-cli
- name: Check for typos
run: pipx run sphinx-lint src
run: typos

6 changes: 6 additions & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[default]
extend-ignore-identifiers-re = [
# Ignore things that look like gui_xztNdXA2oFNB
"gui_.*",
]

4 changes: 2 additions & 2 deletions exts/coding_guidelines/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Ferrocene Language Specification Conformance
Various checks are performed against the ``:fls:`` option present in ``guideline`` directives to
ensure they are valid.

Coverage of the coding guidlines over the FLS is calculated.
Coverage of the coding guidelines over the FLS is calculated.

Each coding guideline has its ``:fls:`` option turned into a hyperlink to the corresponding element
within the FLS to be able to navigate there directly.

Further an ``spec.lock`` file located at ``root/src/spec.lock`` is validated against the currently
deployed version of the Ferrocene Language Spec and the build is failed if there is discrepency.
deployed version of the Ferrocene Language Spec and the build is failed if there is discrepancy.

Links to the Rust standard library
==================================
Expand Down
2 changes: 1 addition & 1 deletion src/coding-guidelines/macros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ Macros

The following is a macro which shows referring to a vector entity using a non-global path. Depending on
where the macro is used a different `Vec` could be used than is intended. If scope where this is used
defines a struct `Vec` which is not preset at the macro defintion, the macro user might be intending to
defines a struct `Vec` which is not preset at the macro definition, the macro user might be intending to
use that in the macro.

.. code-block:: rust
Expand Down
2 changes: 1 addition & 1 deletion src/process/style-guideline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ appropriate ``category``.

These are guidelines for which no enforcement is expected and any non-compliance **MAY** be disregarded.

*Note*: The ``retired`` ``status`` supercedes any ``category`` assigned a guideline, effectively
*Note*: The ``retired`` ``status`` supersedes any ``category`` assigned a guideline, effectively
conferring upon the guideline the ``category`` of ``disapplied`` with no ability to recategorize it
to ``mandatory``, ``required``, or ``advisory``. The ``category`` assigned the guideline at the time
it is retired is kept.
Expand Down