address fragility in documentation spellcheck tests #1015
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: Due to a blank line lurking in the aspell local dictionary, aspell missed several spelling errors. Drop blank line, then fix spelling errors and add words to local dictionary.
Problem: spaces in local dictionary can cause aspell to silently miss spelling errors. Check for blank lines in dictionary in "spellcheck" wrapper script and exit with an error if one is found so that spell checking will fail in an obvious way. Note: aspell-0.60.7~20110 (Ubuntu 16.04.2 LTS) is silent. The version on travis does emit an error, although tests were still passing: Error: /home/travis/build/flux-framework/flux-core/ flux-core-0.6.0-345-g9283c84/_build/../doc/test/spell.en.pws: The word "" is invalid. Empty string.
Codecov Report
@@ Coverage Diff @@
## master #1015 +/- ##
=========================================
+ Coverage 77.59% 77.6% +0.01%
=========================================
Files 151 151
Lines 25779 25779
=========================================
+ Hits 20002 20005 +3
+ Misses 5777 5774 -3
Continue to review full report at Codecov.
|
|
Seems very straightforward. Merging. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Apparently aspell can't handle blank lines in its local dictionary, and the result is it fails to detect some spelling errors.
Drop blank line from pws file, add a check to the aspell wrapper script to cause tests to fail should a blank line be added in the future, and finally fix some spelling errors that were not being caught.