Skip to content

MRG: use doccer to fill docstrings#5921

Merged
larsoner merged 3 commits intomne-tools:masterfrom
larsoner:doccer
Feb 13, 2019
Merged

MRG: use doccer to fill docstrings#5921
larsoner merged 3 commits intomne-tools:masterfrom
larsoner:doccer

Conversation

@larsoner
Copy link
Copy Markdown
Member

@larsoner larsoner commented Feb 11, 2019

This is a proof-of-concept for #5753. Done:

  • updated decorator.py to get any bugfixes
  • convert verbose decorator itself to be a docfiller
  • changed two files to use the new format: epochs.py and source_estimate.py.
  • update all files

Posting to get comments before I replace the remaining 334 (!) instances of verbose : in our codebase.

Closes #5753.

@larsoner
Copy link
Copy Markdown
Member Author

This pull request introduces 2 alerts when merging 650b1b8 into d54144f - view on LGTM.com

new alerts:

  • 2 for Wrong number of arguments in a call

Comment posted by LGTM.com

@agramfort
Copy link
Copy Markdown
Member

So far so good on my side

@massich
Copy link
Copy Markdown
Contributor

massich commented Feb 12, 2019

Great +10000

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 12, 2019

Codecov Report

Merging #5921 into master will increase coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #5921      +/-   ##
==========================================
+ Coverage    88.7%   88.71%   +0.01%     
==========================================
  Files         399      399              
  Lines       72139    72224      +85     
  Branches    12098    12134      +36     
==========================================
+ Hits        63989    64074      +85     
- Misses       5214     5215       +1     
+ Partials     2936     2935       -1

@larsoner
Copy link
Copy Markdown
Member Author

@agramfort okay to merge once CI's are happy? Then I can finish rank and picks PRs.

@larsoner larsoner changed the title RFC: use doccer to fill docstrings MRG: use doccer to fill docstrings Feb 12, 2019
@mmagnuski
Copy link
Copy Markdown
Member

I like it a lot 👍
BTW Why does codecov reports -3.46% coverage drop?

@larsoner
Copy link
Copy Markdown
Member Author

Because there is a failing test I need to fix

@larsoner
Copy link
Copy Markdown
Member Author

This pull request introduces 2 alerts when merging affac11 into 7856133 - view on LGTM.com

new alerts:

  • 2 for Wrong number of arguments in a call

Comment posted by LGTM.com

@agramfort
Copy link
Copy Markdown
Member

agramfort commented Feb 12, 2019 via email

@larsoner
Copy link
Copy Markdown
Member Author

This pull request introduces 2 alerts when merging 6a9fbee into fd91ebe - view on LGTM.com

new alerts:

  • 2 for Wrong number of arguments in a call

Comment posted by LGTM.com

@larsoner
Copy link
Copy Markdown
Member Author

Travis error is spurious download error

@larsoner larsoner merged commit 5a0bbee into mne-tools:master Feb 13, 2019
@larsoner larsoner deleted the doccer branch February 13, 2019 01:53
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.

MAINT: DRY our docstrings

4 participants