Skip to content

Commit

Permalink
Convert for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
check-spelling-bot authored and jsoref committed Feb 26, 2024
1 parent d2f65b9 commit c1e33ce
Show file tree
Hide file tree
Showing 161 changed files with 997 additions and 492 deletions.
7 changes: 5 additions & 2 deletions @actions-upload-artifact.md
Expand Up @@ -3,7 +3,7 @@
1. The official way to upload an artifact is [actions/upload-artifact](https://github.com/actions/upload-artifact)
2. That uses [@actions/artifact](https://github.com/actions/toolkit/tree/main/packages/artifact)
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)
4. That uses [@actions/http-client/auth](https://github.com/actions/http-client/blob/544584c8ca4a255395fd73c66bc5eb90ac8abea1/auth.ts)
4. That uses [@actions/http-client/auth](https://raw.githubusercontent.com/actions/http-client/544584c8ca4a255395fd73c66bc5eb90ac8abea1/auth.ts)

The underlying stuff uses:

Expand Down Expand Up @@ -55,7 +55,7 @@ curl -X POST -d @$fileToUpload -vvv \

```

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)
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)

Few highlights:

Expand All @@ -66,3 +66,6 @@ Few highlights:
1. create an artifact container
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.
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.

---
[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)
3 changes: 3 additions & 0 deletions @dependabot.md
Expand Up @@ -21,3 +21,6 @@ https://github.community/t/permissions-nesecary-to-comment-on-a-pr/179047/2

1. create an empty commit and push that.
2. amend the current commit and force push it. (This might upset `@dependabot`)

---
[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)
9 changes: 6 additions & 3 deletions Accepting-Suggestions.md
Expand Up @@ -45,9 +45,9 @@ You probably want to use `git-bash` from https://git-scm.com/download/win (insta

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.

- 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).
- 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.
- 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).
- There are probably `Unrecognized words` that need to be added to [`expect.txt`](Configuration.md#expect) (or some variant).
- 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.
- 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).

## Preformatted commit (v0.0.22+)

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

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".

---
[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)
7 changes: 5 additions & 2 deletions Archaic-words.md
Expand Up @@ -6,7 +6,7 @@ That dictionary is fairly comprehensive. Unfortunately, it has a number of archa

## Compensating

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

Expand All @@ -17,5 +17,8 @@ That dictionary is fairly comprehensive. Unfortunately, it has a number of archa
- [occurence](https://english.stackexchange.com/questions/431928/is-occurence-a-word) (obsolete) -- to be removed from [microsoft/terminal](https://github.com/microsoft/terminal/pull/9679)
- [Sorce](https://en.wiktionary.org/wiki/Sorce) (surname) -- removed from [microsoft/winget-cli](https://github.com/microsoft/winget-cli/commit/3c10211f321701f313ca56593e4944f963110dbe)
- [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)
- [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)
- [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)
- [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)

---
[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)
7 changes: 5 additions & 2 deletions Behavior-change:-Consumed-line-endings.md
@@ -1,8 +1,8 @@
# Behavior change: Consumed line endings

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.
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.

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.
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.

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

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

I couldn't think of any better contortions to prevent this messy output.

---
[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)
5 changes: 4 additions & 1 deletion Behavior-change:-Dropping-word-stemming.md
Expand Up @@ -16,4 +16,7 @@ This allows one to add just a single entry (the stem) to a **dictionary** / **ex

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.

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%.
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%.

---
[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)
3 changes: 3 additions & 0 deletions Behavior-change:-File-line-column-notation.md
Expand Up @@ -7,3 +7,6 @@ As of v0.0.21, the notation will be something like: `.github/workflows/spelling.
filename:line-number:initial-offset ... end-offset.

This should be friendlier to tools like `vi` or `VSCode`.

---
[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)
5 changes: 4 additions & 1 deletion Behavior-change:-Ignoring-two-letter-words.md
Expand Up @@ -4,4 +4,7 @@ Afaict, two letter words just aren't worth the effort of spell checking.

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.

See [[Autodetect valid word lengths|Feature: Autodetect valid word lengths]] for more information.
See [Autodetect valid word lengths](./Feature:-Autodetect-valid-word-lengths.md) for more information.

---
[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)
3 changes: 3 additions & 0 deletions Behavior-change:-Job-Summaries.md
Expand Up @@ -22,3 +22,6 @@ Job Summaries are an alternative to comments
## Timeline

I haven't figured out how to integrate this feature into my workflow.

---
[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)
3 changes: 3 additions & 0 deletions Behavior-change:-Log-output-order.md
Expand Up @@ -9,3 +9,6 @@ Generally there are far fewer skipped files than unrecognized words, so listing
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.

I'm not sure when I'll do this, but, probably soon.

---
[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)
11 changes: 7 additions & 4 deletions Behavior-change:-Patterns-masking-character.md
Expand Up @@ -6,16 +6,16 @@ Originally patterns resulted in roughly a single "` `", and more recently a "` `

## Problems

With the introduction of [[Forbidden patterns|Feature: Forbidden patterns]], how those masked items worked mattered a bit.
With the introduction of [Forbidden patterns](./Feature:-Forbidden-patterns.md), how those masked items worked mattered a bit.

Specifically, if one used this pattern (from [[Configuration Examples: patterns]]):
Specifically, if one used this pattern (from [Configuration Examples: patterns](./Configuration-Examples:-patterns.md)):

```
# version suffix <word>v#
[Vv]\d+(?:\b|(?=[a-zA-Z_]))
```

And this forbidden pattern (from [[Configuration Examples: forbidden]]):
And this forbidden pattern (from [Configuration Examples: forbidden](./Configuration-Examples:-forbidden.md)):

```
# Reject duplicate words
Expand Down Expand Up @@ -54,4 +54,7 @@ Instead of masking `patterns` with "` `", as of [v0.0.20](https://github.com/che

It's unlikely that anyone will notice this change as the only place this should matter is forbidden patterns which are v0.0.20 feature.

The spell checker itself ignores non-alpha characters (treating them as equivalent to "` `") already. So the "`=`" is really only relevant during evaluation of [[Forbidden patterns|Feature: Forbidden patterns]].
The spell checker itself ignores non-alpha characters (treating them as equivalent to "` `") already. So the "`=`" is really only relevant during evaluation of [Forbidden patterns](./Feature:-Forbidden-patterns.md).

---
[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)
3 changes: 3 additions & 0 deletions Behavior-change:-case-changes-in-expect.md
Expand Up @@ -16,3 +16,6 @@ FILETYPE
## Proposed change

The UI should at least clearly draw attention to this change, because it's confusing.

---
[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)
3 changes: 3 additions & 0 deletions Breaking-Change:-Dropping-support-for-broken-act.md
Expand Up @@ -27,3 +27,6 @@ As the current version of [nektos/act](https://github.com/nektos/act) is [v0.2.4
## Disclaimer

While I'm fairly certain these bugs existed, since I reported them, and I worked around them, at this time, I can't reproduce them (using old versions of act), so it's possible that there weren't actually shipping versions with these bugs, but I'm pretty sure there were. Oh well.

---
[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)
Expand Up @@ -4,4 +4,7 @@ check-spelling uses [streetsidesoftware/cspell-dicts](https://github.com/streets

This means that `cspell:` paths that reference the old locations are likely to break.

You are likely to encounter a [`dictionary-not-found`](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#dictionary-not-found) error which should walk you through the steps necessary to resolve the problem.
You are likely to encounter a [`dictionary-not-found`](Event-descriptions.md#dictionary-not-found) error which should walk you through the steps necessary to resolve the problem.

---
[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)
3 changes: 3 additions & 0 deletions Breaking-change:-Artifacts-are-zipped.md
Expand Up @@ -16,3 +16,6 @@ Instead of trying to upload a half dozen or so tiny files, check-spelling will n

- If someone upgrades the check job to a version that does this, but doesn't upgrade the comment job to a version that supports this, the generated artifacts will not work.
- If a workflow has custom code relying on the files from artifact, it will need to be adjusted. -- I doubt anyone is doing this.

---
[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)
5 changes: 4 additions & 1 deletion Breaking-change:-Dropping-printf-special-cases.md
Expand Up @@ -2,7 +2,7 @@

## Background

When the core for check-spelling was initially developed, it was a lot simpler and didn't have any support for [`patterns`](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns).
When the core for check-spelling was initially developed, it was a lot simpler and didn't have any support for [`patterns`](./Configuration-Examples:-patterns.md).

As it was often run against C/C++ repositories, code was baked-in to handle `\n`, `\r`, and `\t`.

Expand All @@ -19,3 +19,6 @@ If you're currently relying on that special casing, you'll need to add entries t
## Schedule

Expecting to deploy in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.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)

0 comments on commit c1e33ce

Please sign in to comment.