Skip to content

spell check docs with spellintian (SC-770)#1223

Merged
TheRealFalcon merged 2 commits into
canonical:mainfrom
holmanb:holmanb/spellcheck
Feb 2, 2022
Merged

spell check docs with spellintian (SC-770)#1223
TheRealFalcon merged 2 commits into
canonical:mainfrom
holmanb:holmanb/spellcheck

Conversation

@holmanb
Copy link
Copy Markdown
Member

@holmanb holmanb commented Jan 30, 2022

Fix spelling errors

- Add Makefile target that checks for spelling errors
- Add Makefile target that fixes spelling errors
- Add spelling check to travis doc tests
- Fix various spelling errors in the docs 

Test Steps

revert the bug fixes in the second commit to test the new makefile target functionality

git reset --hard HEAD^
make check_spelling
echo $?
make fix_spelling
make check_spelling # note the one error fix_spelling couldn't automagically fix
# manually fix doc/rtd/topics/datasources/smartos.rst
make fix_spelling
echo $?

Note that this build fails (before the spelling fixes) and this build succeeds (after the fixes).

@holmanb holmanb force-pushed the holmanb/spellcheck branch 7 times, most recently from eee8a30 to 67f704e Compare January 30, 2022 02:10
@holmanb holmanb changed the title spell check docs with spellintian spell check docs with spellintian (SC-770) Jan 30, 2022
Copy link
Copy Markdown
Contributor

@TheRealFalcon TheRealFalcon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There goes our possibility of ever joining Hacktoberfest...

I noticed on Travis:

0.46s$ make check_spelling
Makefile:88: recipe for target '_check_spelling' failed
The command "make check_spelling" exited with 0.

I don't think the check is running correctly there. Have we tried with a misspeled word to see if Travis fails on it?

Comment thread Makefile Outdated
Comment thread Makefile
@holmanb
Copy link
Copy Markdown
Member Author

holmanb commented Jan 31, 2022

#> There goes our possibility of ever joining Hacktoberfest...

We have plenty of text files with spelling errors outside of doc for the Hacktoberfesters to have a go at ;)

I noticed on Travis:

0.46s$ make check_spelling
Makefile:88: recipe for target '_check_spelling' failed
The command "make check_spelling" exited with 0.

I don't think the check is running correctly there. Have we tried with a misspeled word to see if Travis fails on it?

Fixed. This was some mostly harmless, but I came up with a slightly different solution to prevent that warning.

@holmanb holmanb force-pushed the holmanb/spellcheck branch from 67f704e to 8084b35 Compare January 31, 2022 23:14
@holmanb holmanb force-pushed the holmanb/spellcheck branch from 8084b35 to b81637a Compare January 31, 2022 23:15
@holmanb holmanb force-pushed the holmanb/spellcheck branch from 558da2a to ade5693 Compare January 31, 2022 23:31
Copy link
Copy Markdown
Contributor

@TheRealFalcon TheRealFalcon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This will improve the quality of our docs, and hopefully make us look a little more professional (until people read my PR comments).

@TheRealFalcon TheRealFalcon merged commit 7522845 into canonical:main Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants