docs: Update cspell github action and configuration #2325
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luanpotter
force-pushed
the
luan.cspell.action-test
branch
from
8362a30
to
23049c9
Compare
luanpotter
changed the title
spydon
approved these changes
Feb 6, 2023
| @@ -37,6 +37,9 @@ extension ColorExtension on Color { | |||
| ); | |||
| } | |||
|
|
|||
| // used as an example hex color code on the documentation below | |||
There was a problem hiding this comment.
Suggested change
| // used as an example hex color code on the documentation below | |
| // Used as an example hex color code on the documentation below. |
| @@ -42,6 +42,9 @@ extension PaintExtension on Paint { | |||
| return Paint()..color = color; | |||
| } | |||
|
|
|||
| // used as an example hex color code on the documentation below | |||
There was a problem hiding this comment.
Suggested change
| // used as an example hex color code on the documentation below | |
| // Used as an example hex color code on the documentation below. |
wolfenrain
approved these changes
Feb 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I am on a crusade to improve our spellchecking. I have a big PR that I am now going to break down into very small chunks to for review.
zwaldowski's cspell-action has been deprecated in favor of streetsidesoftware/cspell-action.
This PR:
Note: I think we should make a distinction between things that should be in a dictionary (e.g.
AABB, a standard industry acronym that we expect people to know what it is) and specific edge-cases/ignore rules for specific parts of specific files (e.g. something likefcccwhich is meaningless outside of the very specific context in which it is used). For the latter, I believe we should use case-by case exceptions.Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?