documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Improve spellcheck

Open stevepiercy opened this issue 3 years ago • 6 comments

It would be good to improve spellcheck and consistency of spellings. For example:

JavaScript, instead of javascript / Javascript / js
NodeJS, instead of nodejs / Node.js / node

Use caution when doing global find and replaces to not overwrite commands or code blocks that use those strings.

To improve spellcheck, add words to styles/Vocab/Plone/accept.txt and styles/Vocab/Plone/reject.txt.

See also:

  • https://6.docs.plone.org/contributing/setup-build.html#vale

Contributing

  • https://6.docs.plone.org/contributing/
  • https://6.docs.plone.org/contributing/first-time.html

stevepiercy avatar Feb 21 '22 02:02 stevepiercy

i observed that this issue is mentioned in a pull request named https://github.com/plone/plone.restapi-client/pull/5, which is already merged so i want to conferm whether this issue is resolved now or i can start working on this ?

chirayu-humar avatar Aug 03 '23 23:08 chirayu-humar

That issue is for a different repository and project. Spell checking can always be improved in this repository. Please feel free to work on improving the quality of spelling.

stevepiercy avatar Aug 03 '23 23:08 stevepiercy

I am working on this issue

chirayu-humar avatar Aug 04 '23 01:08 chirayu-humar

i have generated a draft pull request but being honest and sorry to say but, i am little bit unsure that it will work properly because i have not tested it on my local system because i did knew where is this spell check is used further in codebase, to figure it out it will take some time.

chirayu-humar avatar Aug 04 '23 05:08 chirayu-humar

@stevepiercy, plz close this issue as this is already solved

Akshat2Jain avatar Sep 04 '23 06:09 Akshat2Jain

@Akshat2Jain no, there is a LOT more work to do. There are still hundreds of errors, warnings, and suggestions.

stevepiercy avatar Sep 04 '23 07:09 stevepiercy