Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

address fragility in documentation spellcheck tests #1015

Merged
merged 2 commits into from Mar 26, 2017

Conversation

Projects
None yet
4 participants
@garlick
Copy link
Member

garlick commented Mar 25, 2017

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.

@coveralls

This comment has been minimized.

Copy link

coveralls commented Mar 25, 2017

Coverage Status

Coverage increased (+0.004%) to 77.902% when pulling 2113801 on garlick:aspell_sadness into f78422e on flux-framework:master.

garlick added some commits Mar 25, 2017

doc: fix spelling errors
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.
test/doc: detect blank linkes in aspell 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.

@garlick garlick force-pushed the garlick:aspell_sadness branch from 2113801 to ed3f7f0 Mar 25, 2017

@codecov-io

This comment has been minimized.

Copy link

codecov-io commented Mar 25, 2017

Codecov Report

Merging #1015 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            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
Impacted Files Coverage Δ
src/common/libflux/tagpool.c 95.12% <0%> (-1.22%) ⬇️
src/common/libflux/message.c 83.64% <0%> (+0.12%) ⬆️
src/common/libflux/handle.c 86.04% <0%> (+0.25%) ⬆️
src/common/libflux/rpc.c 91.17% <0%> (+0.73%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f78422e...ed3f7f0. Read the comment docs.

@coveralls

This comment has been minimized.

Copy link

coveralls commented Mar 25, 2017

Coverage Status

Coverage increased (+0.02%) to 77.914% when pulling ed3f7f0 on garlick:aspell_sadness into f78422e on flux-framework:master.

@grondo

This comment has been minimized.

Copy link
Contributor

grondo commented Mar 26, 2017

Seems very straightforward. Merging.

@grondo grondo merged commit 02746a8 into flux-framework:master Mar 26, 2017

4 checks passed

codecov/patch Coverage not affected when comparing f78422e...ed3f7f0
Details
codecov/project 77.6% (+0.01%) compared to f78422e
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.02%) to 77.914%
Details

@garlick garlick deleted the garlick:aspell_sadness branch Mar 26, 2017

@grondo grondo referenced this pull request Mar 28, 2017

Closed

0.7.0 Release Notes #1019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.