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

Update docstrings and doc site #56

Merged
merged 3 commits into from
Feb 20, 2018
Merged

Update docstrings and doc site #56

merged 3 commits into from
Feb 20, 2018

Conversation

sauln
Copy link
Member

@sauln sauln commented Feb 20, 2018

All of the docstrings render nicely using numpydocs and sphinx. Can be seen at https://MLWave.github.io/kepler-mapper/reference.html.

@pep8speaks
Copy link
Contributor

Hello @sauln, Thank you for submitting the Pull Request !

Line 189:101: E501 line too long (133 > 100 characters)
Line 196:1: E303 too many blank lines (4)

Line 8:1: E302 expected 2 blank lines, found 1
Line 21:101: E501 line too long (158 > 100 characters)
Line 47:101: E501 line too long (243 > 100 characters)
Line 82:51: E712 comparison to False should be 'if cond is False:' or 'if not cond:'

Line 43:101: E501 line too long (109 > 100 characters)
Line 44:101: E501 line too long (130 > 100 characters)
Line 53:101: E501 line too long (404 > 100 characters)
Line 56:101: E501 line too long (666 > 100 characters)
Line 67:101: E501 line too long (114 > 100 characters)
Line 110:17: E722 do not use bare except'
Line 114:9: E722 do not use bare except'
Line 177:101: E501 line too long (119 > 100 characters)
Line 191:101: E501 line too long (136 > 100 characters)
Line 194:101: E501 line too long (153 > 100 characters)
Line 197:101: E501 line too long (112 > 100 characters)
Line 210:101: E501 line too long (151 > 100 characters)
Line 224:101: E501 line too long (111 > 100 characters)
Line 237:101: E501 line too long (153 > 100 characters)
Line 282:101: E501 line too long (119 > 100 characters)
Line 350:101: E501 line too long (129 > 100 characters)
Line 368:101: E501 line too long (111 > 100 characters)
Line 374:9: E303 too many blank lines (2)

Line 24:5: E303 too many blank lines (2)
Line 37:20: W291 trailing whitespace
Line 48:101: E501 line too long (104 > 100 characters)
Line 54:1: E302 expected 2 blank lines, found 1

Do see the Hitchhiker's guide to code style

@codecov-io
Copy link

codecov-io commented Feb 20, 2018

Codecov Report

Merging #56 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev      #56   +/-   ##
=======================================
  Coverage   74.77%   74.77%           
=======================================
  Files           5        5           
  Lines         329      329           
  Branches       74       74           
=======================================
  Hits          246      246           
  Misses         71       71           
  Partials       12       12
Impacted Files Coverage Δ
kmapper/nerve.py 85.71% <ø> (ø) ⬆️
kmapper/cover.py 100% <ø> (ø) ⬆️
kmapper/kmapper.py 78.04% <ø> (ø) ⬆️

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 9f16259...c730efe. Read the comment docs.

@sauln sauln mentioned this pull request Feb 20, 2018
8 tasks
@sauln sauln merged commit b457768 into scikit-tda:dev Feb 20, 2018
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