Check spelling 0.0.24 #3051

jsoref · 2024-11-26T06:45:49Z


*Related Issue(s)*
*Has Unit Tests (y/n)*
*Documentation Included (y/n)*

Change Description

Upgrades check-spelling to v0.0.24 (GitHub will start triggering various annoying warnings for older versions at some point in the near future)
Remove dead rtems5 link (the link checker was complaining)
a handful of spelling fixes based on newer heuristics in spell-check-this
harmonize the Checklist markdown tables (some of which had incorrect links)
a bunch of accessibility fixes based on:

Do not use (click) here links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()

Rationale

Testing/Review Recommendations

Testing was performed inhttps://github.com/check-spelling-sandbox/fprime/actions/

Future Work

I might actually ship a v0.0.25 in the near future (but quite likely not before the deprecations trigger).

Signed-off-by: Josh Soref <[email protected]>

for many aspects of F´ are available Signed-off-by: Josh Soref <[email protected]>

Signed-off-by: Josh Soref <[email protected]>

jsoref · 2024-11-26T06:46:32Z

.github/actions/markdown-check/mlc-config.json

@@ -5,6 +5,9 @@
      },
      {
        "pattern": "https?://"
+      },
+      {
+        "pattern": "^\\.\\./tree/HEAD/"


This relates to some magic in the advice file which relies on GitHub rendering the markdown in a very specific context where the link is valid)...

jsoref · 2024-11-26T06:46:48Z

.github/actions/spelling/advice.md

+  `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
+../tree/HEAD/README.md) (on whichever branch you're using).


This works when rendered by check-spelling in GitHub, but it upsets the link checker (see previous comment)

jsoref · 2024-11-26T06:48:00Z

.github/actions/spelling/candidate.patterns

-\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\)
+#\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\)


I commented this one out because it wasn't terribly useful, the items it found were generally correctly spelled phrases as opposed to people and as such it was more likely to mask a bug than quiet noise about people/accounts.

jsoref · 2024-11-26T06:49:42Z

.github/actions/spelling/expect.txt

 atype
+atypes


This pair is here because of a difference of opinions between the old workflow and the new workflow. In the new workflow atype can be removed.

jsoref · 2024-11-26T06:50:21Z

.github/actions/spelling/expect.txt

@@ -281,12 +294,11 @@ errornum
 ert
 esb
 ethanchee
-eturn


This was probably from a pattern that I've improved

jsoref · 2024-11-26T07:06:13Z

Svc/ActiveLogger/docs/sdd.md

-Document | Link
-------- | ----
-Design Checklist | [Link](Checklist_Design.xlsx)
-Code Checklist | [Link](Checklist_Code.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
+Checklist |
+-------- |
+[Design](Checklist_Design.xlsx) |
+[Code](Checklist_Code.xlsx) |
+[Unit Test](Checklist_Unit_Test.xls) |


There are a couple of variations on these checklists. I don't think the two column format helps anyone, it certainly hurts anyone using a screen reader (and it also hides bugs ...).

jsoref · 2024-11-26T07:07:36Z

Svc/PolyDb/docs/sdd.md

-Document | Link
-------- | ----
-Design Checklist | [Link](Checklist_Design.xlsx)
-Code Checklist | [Link](Checklist_Design.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
+Checklist |
+-------- |
+[Design](Checklist_Design.xlsx) |
+[Code](Checklist_Code.xlsx) |
+[Unit Test](Checklist_Unit_Test.xls) |


This is one of the tables where there was a bug in the links. The second row said Code but had a Link to Design.

jsoref · 2024-11-26T07:12:05Z

Utils/Hash/openssl/sha.h

- * the following conditions are aheared to.  The following conditions
+ * the following conditions are adhered to.  The following conditions


this license block is a bit of a mess since it's original to the license block. I have an experimental feature that lets me ignore blocks instead of lines, but I'm not particularly comfortable with the design.

As I just made a PR yesterday to a project which unfortunately had included wil in expect.txt, I'd encourage people use patterns.txt or excludes.txt if they really want to accept specific instances of typos, lest they accidentally enable typos to spread.

patterns.txt

# openssl license typo the following conditions are adhered to

excludes.txt

^\QUtils/Hash/openssl/sha.h\E$

jsoref · 2024-11-26T07:13:13Z

docs/UsersGuide/cmake/cmake-api.md

@@ -26,7 +26,6 @@ define types and headers needed for F´ for any embedded system they desire.
 [Platform Template](../api/cmake/platform/platform-template.md): Platform file template documentation  
 [Linux](../api/cmake/platform/Linux.md): Linux platform support  
 [Darwin](../api/cmake/platform/Darwin.md): Darwin (macOS) platform support  
-[rtems5](../api/cmake/platform/rtems5.md): RTEMS 5 initial support  


As noted, the link checker didn't like this link. I did spend a bit of time trying to follow the history of its introduction/removal, but gave up.

jsoref · 2024-11-26T07:13:59Z

Autocoders/Python/doc/ReadMe.txt

-Each type of code has it's own unique custom XML syntax. To date
+Each type of code has its own unique custom XML syntax. To date


another new heuristic

jsoref added 28 commits November 24, 2024 22:41

Remove stale RTEMS link

a9db41b

Change line endings

4726b0f

link: Checklist

bfa24a0

Signed-off-by: Josh Soref <[email protected]>

link: complete list is available

6e73aaf

Signed-off-by: Josh Soref <[email protected]>

link: described in detail

1fd550b

Signed-off-by: Josh Soref <[email protected]>

link: F' key features

e873c94

Signed-off-by: Josh Soref <[email protected]>

link: Fw::Buffer documentation is available

0711e39

Signed-off-by: Josh Soref <[email protected]>

link: installing cmake command line tools on a mac

8b79ae0

Signed-off-by: Josh Soref <[email protected]>

link: Svc.StaticMemory is described in more detail

ac7d4ac

Signed-off-by: Josh Soref <[email protected]>

link: Svc.BufferManager is described in more detail

46ee125

Signed-off-by: Josh Soref <[email protected]>

link: testing_fw/predicates.py

abec028

Signed-off-by: Josh Soref <[email protected]>

link: the source code

2da9f1b

Signed-off-by: Josh Soref <[email protected]>

link: tutorial app is available

f5c72ec

Signed-off-by: Josh Soref <[email protected]>

link: tutorials

661f342

for many aspects of F´ are available Signed-off-by: Josh Soref <[email protected]>

spelling: a

03bef2a

Signed-off-by: Josh Soref <[email protected]>

spelling: adhered

0c85c1f

Signed-off-by: Josh Soref <[email protected]>

spelling: cannot

265afed

Signed-off-by: Josh Soref <[email protected]>

spelling: case-sensitive

ee9fdac

Signed-off-by: Josh Soref <[email protected]>

spelling: deployment

4b0c4df

Signed-off-by: Josh Soref <[email protected]>

spelling: filter events based on event severity

862916c

Signed-off-by: Josh Soref <[email protected]>

spelling: its

3eee116

Signed-off-by: Josh Soref <[email protected]>

spelling: nonexistent

5e1a260

Signed-off-by: Josh Soref <[email protected]>

spelling: prepending

c61c157

Signed-off-by: Josh Soref <[email protected]>

spelling: products

6f1c425

Signed-off-by: Josh Soref <[email protected]>

spelling: schema

045057b

Signed-off-by: Josh Soref <[email protected]>

spelling: stressful

8db109b

Signed-off-by: Josh Soref <[email protected]>

spelling: the

d555ece

Signed-off-by: Josh Soref <[email protected]>

spelling: valued

7ceffed

Signed-off-by: Josh Soref <[email protected]>

jsoref commented Nov 26, 2024

View reviewed changes

Add check-spelling

e0d1084

jsoref force-pushed the check-spelling-0.0.24 branch from 13a5b6a to e0d1084 Compare November 26, 2024 07:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check spelling 0.0.24 #3051

Check spelling 0.0.24 #3051

jsoref commented Nov 26, 2024

jsoref Nov 26, 2024

jsoref Nov 26, 2024

jsoref Nov 26, 2024 •

edited

Loading

jsoref Nov 26, 2024

jsoref Nov 26, 2024

jsoref Nov 26, 2024

jsoref Nov 26, 2024

jsoref Nov 26, 2024

jsoref Nov 26, 2024

jsoref Nov 26, 2024

		`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
		../tree/HEAD/README.md) (on whichever branch you're using).

		\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\)
		#\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\)

		* the following conditions are aheared to. The following conditions
		* the following conditions are adhered to. The following conditions

		Each type of code has it's own unique custom XML syntax. To date
		Each type of code has its own unique custom XML syntax. To date

		atype
		atypes

Check spelling 0.0.24 #3051

Are you sure you want to change the base?

Check spelling 0.0.24 #3051

Conversation

jsoref commented Nov 26, 2024

Change Description

Rationale

Testing/Review Recommendations

Future Work

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patterns.txt

excludes.txt

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref Nov 26, 2024 •

edited

Loading

`patterns.txt`

`excludes.txt`