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

Added pyenchant/pylint automated spell checking #159

Merged
merged 5 commits into from Apr 8, 2021

Conversation

eli88fine
Copy link
Contributor

@eli88fine eli88fine commented Apr 8, 2021

You may need to run apt-get install -y enchant to install it locally. But it appears to exist already in the github CI environment.

Currently, there's no easy way to ignore spellchecking the code that's in the comments, so I'm using sphinx directives (which are ignored). I raised some issues with pylint to see if they're open to me correcting this.

pylint-dev/pylint#4320
pylint-dev/pylint#4319

@codecov
Copy link

codecov bot commented Apr 8, 2021

Codecov Report

Merging #159 (ae78d60) into development (4caf277) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@              Coverage Diff              @@
##           development      #159   +/-   ##
=============================================
  Coverage       100.00%   100.00%           
=============================================
  Files               22        22           
  Lines             3807      3807           
  Branches           431       431           
=============================================
  Hits              3807      3807           
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/mantarray_desktop_app/data_analyzer.py 100.00% <ø> (ø)
src/mantarray_desktop_app/fifo_read_producer.py 100.00% <ø> (ø)
src/mantarray_desktop_app/fifo_simulator.py 100.00% <ø> (ø)
src/mantarray_desktop_app/file_writer.py 100.00% <ø> (ø)
src/mantarray_desktop_app/instrument_comm.py 100.00% <ø> (ø)
src/mantarray_desktop_app/mc_comm.py 100.00% <ø> (ø)
src/mantarray_desktop_app/ok_comm.py 100.00% <ø> (ø)
src/mantarray_desktop_app/process_monitor.py 100.00% <ø> (ø)
src/mantarray_desktop_app/request_handler.py 100.00% <ø> (ø)
src/mantarray_desktop_app/server.py 100.00% <ø> (ø)
... and 3 more

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 4caf277...ae78d60. Read the comment docs.

tannermpeterson
tannermpeterson previously approved these changes Apr 8, 2021
# - name: Install enchant (required for pylint spellchecking)
# if: matrix.IS_FASTEST_JOB == true
# run: apt-get install -y enchant

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can this commented code be deleted?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure

tannermpeterson
tannermpeterson previously approved these changes Apr 8, 2021
@tannermpeterson tannermpeterson merged commit 41563c9 into development Apr 8, 2021
@tannermpeterson tannermpeterson deleted the pyenchant branch April 8, 2021 21:51
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.

None yet

3 participants