Skip to content

Commit d7d315a

Browse files
check-spelling-botjsoref
authored andcommitted
Convert for docs
1 parent 3e05876 commit d7d315a

File tree

163 files changed

+1027
-515
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+1027
-515
lines changed

@actions-upload-artifact.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
1. The official way to upload an artifact is [actions/upload-artifact](https://github.com/actions/upload-artifact)
44
2. That uses [@actions/artifact](https://github.com/actions/toolkit/tree/main/packages/artifact)
55
3. Specifically, it uses `artifact.create().uploadArtifact(artifactName, files, rootDirectory, options)` see [example](https://github.com/actions/toolkit/tree/main/packages/artifact#example-using-absolute-file-paths)
6-
4. That uses [@actions/http-client/auth](https://github.com/actions/http-client/blob/544584c8ca4a255395fd73c66bc5eb90ac8abea1/auth.ts)
6+
4. That uses [@actions/http-client/auth](https://raw.githubusercontent.com/actions/http-client/544584c8ca4a255395fd73c66bc5eb90ac8abea1/auth.ts)
77

88
The underlying stuff uses:
99

@@ -55,7 +55,7 @@ curl -X POST -d @$fileToUpload -vvv \
5555

5656
```
5757

58-
The implementation in Python: https://github.com/KOLANICH-libs/miniGHAPI.py/blob/09388fba1145275181fe6ca7f7e3c526abc96d4f/miniGHAPI/undocumented.py (it is bound to hash because can be moved into another file in future)
58+
The implementation in Python: https://raw.githubusercontent.com/KOLANICH-libs/miniGHAPI.py/09388fba1145275181fe6ca7f7e3c526abc96d4f/miniGHAPI/undocumented.py (it is bound to hash because can be moved into another file in future)
5959

6060
Few highlights:
6161

@@ -66,3 +66,6 @@ Few highlights:
6666
1. create an artifact container
6767
2. upload the artifact into a file within container. THIS MUST BE A RANGE QUERY. IT IS SUSPECTED IT CAN BE USED TO PATCH PARTS OF FILES, WHICH MAY BE USEFUL FOR STORING BINARY DATABASES AND FUSE FILESYSTEMS.
6868
3. PATCH the container. The artifact will not appear within a pipeline without this query. GitHub official action code sets the size in it, but in fact it has no effect at all, likely it is just a discrepancy between the server and client code. It is suspected that the PATCH query can be utilised to make the artifact appear not as a zip archive.
69+
70+
---
71+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

@dependabot.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,6 @@ https://github.community/t/permissions-nesecary-to-comment-on-a-pr/179047/2
2121

2222
1. create an empty commit and push that.
2323
2. amend the current commit and force push it. (This might upset `@dependabot`)
24+
25+
---
26+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Accepting-Suggestions.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ You probably want to use `git-bash` from https://git-scm.com/download/win (insta
4545

4646
The code is provided as a convenience--what it does is take certain recommendations from check-spelling and apply them to the check-spelling configuration directory.
4747

48-
- There are probably `Unrecognized words` that need to be added to [`expect.txt`](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) (or some variant).
49-
- There may be items that are no longer found that need to be removed from [`expect.txt`](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) (or some variant) so that they'd be flagged if they're reintroduced later.
50-
- If there are [suggestions for additions to `excludes.txt`](https://github.com/check-spelling/check-spelling/wiki/Feature:-Heuristic-exclude-suggestions), versions after [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) would apply them, and you could manually add them to [`excludes.txt`](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes) (although this isn't necessary).
48+
- There are probably `Unrecognized words` that need to be added to [`expect.txt`](Configuration.md#expect) (or some variant).
49+
- There may be items that are no longer found that need to be removed from [`expect.txt`](Configuration.md#expect) (or some variant) so that they'd be flagged if they're reintroduced later.
50+
- If there are [suggestions for additions to `excludes.txt`](./Feature:-Heuristic-exclude-suggestions), versions after [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) would apply them, and you could manually add them to [`excludes.txt`](Configuration.md#excludes) (although this isn't necessary).
5151

5252
## Preformatted commit (v0.0.22+)
5353

@@ -73,3 +73,6 @@ In order for this to be useful, you'll then need to create a merge commit betwee
7373
You could rebase your commits onto the base branch at this point (or in some other order).
7474

7575
A version after 0.0.22 should include instructions for merging. Whether you merge or rebase is up to you or the project to which you're contributing. If you choose to rebase, you'll probably want to rearrange the commits. You might also want to rearrange the commits if you merge -- the order of commands given is designed to be likely to not immediately have merge conflicts but probably doesn't tell the best "story".
76+
77+
---
78+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Archaic-words.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ That dictionary is fairly comprehensive. Unfortunately, it has a number of archa
66

77
## Compensating
88

9-
- You can remove words using `reject` see [[Configuration Examples: reject]]
9+
- You can remove words using `reject` see [Configuration Examples: reject](./Configuration-Examples:-reject.md)
1010
- You can replace the dictionary using `dictionary` (`dictionary.txt` or `dictionary/*.txt`)
1111
- I plan to offer reduced dictionaries (based on implementation experience) which one could select using `DICTIONARY_VERSION`
1212

@@ -19,3 +19,6 @@ That dictionary is fairly comprehensive. Unfortunately, it has a number of archa
1919
- [spae](https://www.dictionary.com/browse/spae) (from Old English), spaebook, spaecraft, spaed, spaedom, spaeing, spaeings, spae-man, spaeman, spaer, Spaerobee, spaes, spaewife, spaewoman, spaework, spaewright -- removed from [microsoft/terminal](https://github.com/microsoft/terminal/commit/dc43524eb23feb9962e5277c639628d0e982f1bf#diff-4a97f7b6bd038d5e4082fe476036b224)
2020
- [wether](https://www.dictionary.com/browse/wether) (from Old English / Old High German) -- removed from [microsoft/terminal](https://github.com/microsoft/terminal/commit/9409e851d043775ea973a7cc50cc1ba0c2f660a2#diff-4a97f7b6bd038d5e4082fe476036b224)
2121
- [untill](https://en.wiktionary.org/wiki/untill) ([archaic spelling](https://books.google.com/ngrams/graph?content=untill%2Cuntil&year_start=1800&year_end=2008&corpus=15&smoothing=3&share=&direct_url=t1%3B%2Cuntill%3B%2Cc0%3B.t1%3B%2Cuntil%3B%2Cc0) of until)
22+
23+
---
24+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Behavior-change:-Consumed-line-endings.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Behavior change: Consumed line endings
22

3-
Through [[v0.0.19|https://github.com/check-spelling/check-spelling/releases/tag/v0.0.19]], the line ending was included as part of the line being parsed.
3+
Through [v0.0.19](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.19), the line ending was included as part of the line being parsed.
44

5-
With the [[v0.0.20|https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20]], the line ending will not be included in the parsed content.
5+
With the [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20), the line ending will not be included in the parsed content.
66

77
This could impact patterns that specifically look for `\n` / `\r` / ….
88

@@ -22,3 +22,6 @@ pkg/strutil/strutil_test.go: ` matches a line_forbidden.patterns entry. (forbidd
2222
```
2323

2424
I couldn't think of any better contortions to prevent this messy output.
25+
26+
---
27+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Behavior-change:-Dropping-word-stemming.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,7 @@ This allows one to add just a single entry (the stem) to a **dictionary** / **ex
1616

1717
The downside to this stemming is that if a repo has both `potato` and `potatos`, the latter was treated as a stem of the former and they were collectively accepted if the former is in the dictionary.
1818

19-
As of [[0.0.17-alpha|https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha]], I'm removing this feature. Those upgrading will probably need to add extra items to their **dictionary** / **expect** files. For `check-spelling` itself, that amounted to 6 new entries out of under 100, so about 6%.
19+
As of [0.0.17-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha), I'm removing this feature. Those upgrading will probably need to add extra items to their **dictionary** / **expect** files. For `check-spelling` itself, that amounted to 6 new entries out of under 100, so about 6%.
20+
21+
---
22+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Behavior-change:-File-line-column-notation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ As of v0.0.21, the notation will be something like: `.github/workflows/spelling.
77
filename:line-number:initial-offset ... end-offset.
88

99
This should be friendlier to tools like `vi` or `VSCode`.
10+
11+
---
12+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Behavior-change:-Ignoring-two-letter-words.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@ Afaict, two letter words just aren't worth the effort of spell checking.
44

55
I will take implementation feedback. But, `prerelease` now, and `0.0.18-alpha` (when it's released), by default, will not complain about two letter words.
66

7-
See [[Autodetect valid word lengths|Feature: Autodetect valid word lengths]] for more information.
7+
See [Autodetect valid word lengths](./Feature:-Autodetect-valid-word-lengths.md) for more information.
8+
9+
---
10+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Behavior-change:-Job-Summaries.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ Job Summaries are an alternative to comments
2222
## Timeline
2323

2424
I haven't figured out how to integrate this feature into my workflow.
25+
26+
---
27+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

Behavior-change:-Log-output-order.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ Generally there are far fewer skipped files than unrecognized words, so listing
99
One should integrate the list of skipped files into `excludes.txt`, which will result in 0 items in this category and effectively the same output as the current state.
1010

1111
I'm not sure when I'll do this, but, probably soon.
12+
13+
---
14+
[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)

0 commit comments

Comments
 (0)