Fix Spelling #814
Fix Spelling #814
Conversation
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>
|
I would really like to get a spell check running on every PR as it’s time consuming to correct & ensure good spelling. |
|
I would be happy to set that up if you'd like? I'll include the whitelist I started building. |
|
Absolutely! I was thinking it would be best to use GH actions unless you have other ideas... |
|
My thoughts exactly. I'll add that to this PR. |
|
I had to fork the markdown spell check and make a few changes otherwise the whitelist ( Let me know what you think of this implementation. Please have a look if I accidentally added any non-words to the whitelist by mistake. |
|
Not sure why it's not showing here but the CI runs through all MD files and checks spelling. Might need a coding genius such as @mtrezza to look over just to make sure it's ok to use this.
|
|
This looks good - and nice that you can easily run it locally! It might be nice to have it add a comment with any issues at some point but probably more effort than it's worth for now. I forked the repo into the org and merged your changes - could you point to the org's fork? |
|
A couple question come to mind...
|
|
It previously didn't, but I've submitted a PR to make sure it does |
|
It actually makes me unreasonably happy that it removes extra spaces, I've spend too much time removing double spaces from PRs! |
_includes/ios/user-interface.md
Outdated
| @@ -734,7 +734,7 @@ That would customize the string to "In progress". The key on the left is the ori | |||
|
|
|||
| Say, you would like to customize the error message in `PFSignUpViewController` that says "The email address "andrew@x" is invalid. Please enter a valid email." You are not sure how to enter this into `Localizable.strings` because it contains a variable. | |||
|
|
|||
| Included in the Parse SDK is a file named `Localizable.string` which includes all the localizable keys in the Parse framework. Browsing this file, developers can find the key for the string they would like to customize. You notice that the string `"The email address \"%@\" is invalid. Please enter a valid email."` is a key in the file. In your own `Localizable.strings`, you can then enter: | |||
| Included in the Parse SDK is a filenamed `Localizable.string` which includes all the localizable keys in the Parse framework. Browsing this file, developers can find the key for the string they would like to customize. You notice that the string `"The email address \"%@\" is invalid. Please enter a valid email."` is a key in the file. In your own `Localizable.strings`, you can then enter: | |||
|
Thanks for extending it code, I'm not actually sure if it's a good idea though. I can see an issue on line 351 of When PRs introduce new code it may mean adding more and more to the If we can, perhaps only spell checking code comments and strings would be a happy medium? - although maybe even that adds too much to the |
|
@dblythy Do you know why this PR has become stale? The docs have been somewhat neglected in the past, but we'll pick this up now and close the open PRs and issues. Do you think it makes sense to merge this before we start? |
|
Should be good for review @mtrezza |
| 1.0a | ||
| unlinking | ||
| nuget-link | ||
| 5.2.x |
There was a problem hiding this comment.
I assume this file is the "ignore" list for the spell check. There are quite a lot of version numbers, does this accept a regex to cover all these version numbers?
There was a problem hiding this comment.
Could you sort the contents of this file alphabetically? Just for better overview. The file looks suspiciously long, maybe there al alphabetical order can give us a better idea about why it contains so many entries.
I've worked through the docs and spellchecked where I can.
Let me know your thoughts!