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

improve ophys docstrings #1126

Merged
merged 1 commit into from
Dec 29, 2019
Merged

improve ophys docstrings #1126

merged 1 commit into from
Dec 29, 2019

Conversation

bendichter
Copy link
Contributor

Copy/paste description from the doc of the schema element where appropriate for better documentation

Motivation

I found in several cases that the doc in the schema is more informative than the docstrings in the functions. Since users are more likely to see these docstrings in the pynwb API documentation page than the doc in the schema yaml files, I decided to replace them where appropriate.

Also, it is best practice for one-liner docstrings to put the triple quotes on the same line as the text.

Copy/paste description from the doc of the schema element where appropriate for better documentation
@codecov
Copy link

codecov bot commented Dec 28, 2019

Codecov Report

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

Impacted file tree graph

@@          Coverage Diff          @@
##             dev   #1126   +/-   ##
=====================================
  Coverage   67.5%   67.5%           
=====================================
  Files         38      38           
  Lines       2302    2302           
  Branches     397     397           
=====================================
  Hits        1554    1554           
  Misses       679     679           
  Partials      69      69
Impacted Files Coverage Δ
src/pynwb/ophys.py 92.8% <ø> (ø) ⬆️

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 4f054b8...2a166ea. Read the comment docs.

@bendichter bendichter merged commit 55cc08e into dev Dec 29, 2019
@rly rly deleted the enh/better_ophys_docstrings branch January 2, 2020 19:18
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.

2 participants