Skip to content

Commit

Permalink
doc: add fix-spelling script to reformat doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
robaerd authored and a-kraschitzer committed Apr 14, 2021
1 parent eb71137 commit 62f6517
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion doc/tutorials/run_reformatting_script_with_docker.md
Expand Up @@ -5,7 +5,7 @@ you can easily build a Docker image and run the script inside a Docker container

## Who Is This Guide For?

Do you want to run the reformat-all script easily and without any hassle? You've come to the right place.
Do you want to run the reformat-all and the fix-spelling script easily and without any hassle? You've come to the right place.

This is a step-by-step guide. Just follow the steps and you are good to go!

Expand Down Expand Up @@ -61,3 +61,11 @@ scripts/dev/reformat-all
```

All your files should be reformatted afterwards.

To also fix spelling errors in your files, run the script:

```sh
scripts/dev/fix-spelling
```

All your spelling errors should be fixed afterwards.

0 comments on commit 62f6517

Please sign in to comment.