Spell check the documentation

[ahcorde]

As part of our spring cleaning, we want to detect spell issues in our documentation and fix it when possible. Here's a potential plan to tackle this issue:

1. We suggest to start checking out the main branch.
2. Identify the files that contain documentation. These are typically .md (Markdown) or .md.in (a Markdown file to be generated by CMake).
3. Install in your system a tool to check for spelling errors (e.g.: aspell in Ubuntu).
4. Run the spell checks in all the documents. Most of the catches will be false positives due to words like Protobuf, CMake and other words that aren't typically in an English dictionary. Ignore all of these until you catch a real spell problem.
5. Fix it. Usually these programs recommend a proper word or you can later manually modify the file with the correct English term.
6. Create a pull request with your fixes. This guide can be helpful. Don't be shy, we'll be kind during the process and help you if you don't have much experience with Gazebo yet or the instructions are not clear enough.

[LeoLin6]

Could I ask if you meant the "main" branch or the default "gzplugin3" branch? Thanks. I think this repo is all good, maybe nitpicking: "performant" isn't an english vocab but should be clear enough

[ahcorde]

I executed codespell I can find this failures:

./loader/include/gz/plugin/detail/StaticRegistry.hh:75: Construtor ==> Constructor
./test/integration/plugin.cc:219: acccess ==> access
./test/integration/plugin.cc:589: mulitple ==> multiple
./test/integration/plugin_unload_with_nodelete.cc:28: incremenetd ==> incremented
./test/integration/CMakeLists.txt:54: genrally ==> generally
./test/gtest_vendor/include/gtest/internal/gtest-param-util.h:756: susequently ==> subsequently
./test/gtest_vendor/include/gtest/internal/gtest-param-util.h:767: repored ==> reported, reposed
./core/include/gz/plugin/Factory.hh:110: miniscule ==> minuscule
./core/include/gz/plugin/detail/SpecializedPlugin.hh:221: availabe ==> available
./core/src/Plugin.cc:227: abstact ==> abstract

Yo can open a PR agains the branch main

[LeoLin6]

Whoops I didn't check the cc files, thanks!

[vbalaji21]

I would like to contribute to this thread. Is this thread still open ?