Skip to content

Commit fc97aeb

Browse files
Install typos GHA and fix typos (#129)
* Install typos * Ignore false positives * Fix found typos --------- Co-authored-by: Pete LeVasseur <[email protected]>
1 parent ca519cc commit fc97aeb

File tree

5 files changed

+16
-6
lines changed

5 files changed

+16
-6
lines changed

.github/workflows/build-guidelines.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,14 @@ jobs:
7676
path: build
7777
retention-days: 7
7878
compression-level: 6 # Default compression level for a good balance of speed and size
79-
lint_rst:
79+
80+
check_typos:
8081
runs-on: ubuntu-latest
8182
steps:
8283
- name: Checkout repository
8384
uses: actions/checkout@v3
85+
- name: Install typos
86+
run: cargo install typos-cli
8487
- name: Check for typos
85-
run: pipx run sphinx-lint src
88+
run: typos
89+

_typos.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[default]
2+
extend-ignore-identifiers-re = [
3+
# Ignore things that look like gui_xztNdXA2oFNB
4+
"gui_.*",
5+
]
6+

exts/coding_guidelines/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Ferrocene Language Specification Conformance
1818
Various checks are performed against the ``:fls:`` option present in ``guideline`` directives to
1919
ensure they are valid.
2020

21-
Coverage of the coding guidlines over the FLS is calculated.
21+
Coverage of the coding guidelines over the FLS is calculated.
2222

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

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

2929
Links to the Rust standard library
3030
==================================

src/coding-guidelines/macros.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ Macros
456456

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

462462
.. code-block:: rust

src/process/style-guideline.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ appropriate ``category``.
214214

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

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

0 commit comments

Comments
 (0)