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

DOC: Improve core docstrings #204

Merged
merged 14 commits into from Jun 26, 2021

Conversation

scottclowe
Copy link
Member

  • Move parameters from __init__ to Experiment docstring.
  • Add Attributes section covering output attributes.
  • Change the Sphinx settings to use numpydoc instead of napolean, which generates better attributes sections in particular.
  • Change df/f0 to Δf/f0.
  • Add link to FISSA paper in Experiment docstring
  • Add versionadded directive to the new methods introduced in RF+ENH+BUG: Use npz for cache; store means #177.

@scottclowe scottclowe added the doc label Jun 26, 2021
@codecov
Copy link

codecov bot commented Jun 26, 2021

Codecov Report

Merging #204 (be90cd6) into master (b03adf1) will decrease coverage by 1.27%.
The diff coverage is 7.14%.

❗ Current head be90cd6 differs from pull request most recent head 5c447ee. Consider uploading reports for the commit 5c447ee to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master     #204      +/-   ##
==========================================
- Coverage   93.31%   92.03%   -1.28%     
==========================================
  Files           8        8              
  Lines         927      942      +15     
  Branches      194      199       +5     
==========================================
+ Hits          865      867       +2     
- Misses         32       45      +13     
  Partials       30       30              
Flag Coverage Δ
nbsmoke 65.18% <7.14%> (-0.84%) ⬇️
unittests 91.71% <7.14%> (-1.27%) ⬇️

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

Impacted Files Coverage Δ
fissa/neuropil.py 91.42% <ø> (ø)
fissa/roitools.py 88.98% <ø> (ø)
fissa/core.py 93.29% <7.14%> (-3.84%) ⬇️

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 b03adf1...5c447ee. Read the comment docs.

@scottclowe scottclowe merged commit 64b4279 into rochefort-lab:master Jun 26, 2021
@scottclowe scottclowe deleted the doc_docstrings branch June 26, 2021 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant