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

MRG: Add links for parameters #5840

Merged
merged 2 commits into from
Jan 29, 2019
Merged

MRG: Add links for parameters #5840

merged 2 commits into from
Jan 29, 2019

Conversation

larsoner
Copy link
Member

WIP because it requires numpy/numpydoc#197, thus the weird pip install for now for CircleCI. Want to make sure it works before getting the NumpyDoc PR merged.

@agramfort
Copy link
Member

can you give a link to a rendered doc to understand what this brings?

@codecov
Copy link

codecov bot commented Jan 16, 2019

Codecov Report

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

@@            Coverage Diff             @@
##           master    #5840      +/-   ##
==========================================
+ Coverage   88.67%   88.69%   +0.01%     
==========================================
  Files         396      396              
  Lines       71805    71916     +111     
  Branches    12065    12084      +19     
==========================================
+ Hits        63675    63785     +110     
+ Misses       5201     5200       -1     
- Partials     2929     2931       +2

@larsoner
Copy link
Member Author

@larsoner larsoner added this to the 0.18 milestone Jan 16, 2019
@agramfort
Copy link
Member

agramfort commented Jan 16, 2019 via email

@larsoner larsoner changed the title WIP: Add links for parameters MRG: Add links for parameters Jan 29, 2019
@larsoner
Copy link
Member Author

Since this touches a lot of files and fixes a bunch of docstring errors, I'd like to merge this one. The only downside is that there will be some cruft in the conf.py until the numpydoc PR gets merged. If it never does, we can just delete the xref stuff from conf.py.

@agramfort
Copy link
Member

you have my blessing. But does it mean it will get harder for people to build the doc?
do we have now install something more?

@larsoner
Copy link
Member Author

No. Eventually, once the numpydoc PR is merged, this will take effect for us. If someone has an old numpydoc, it will still build, just without the links.

@larsoner larsoner merged commit d7fe748 into mne-tools:master Jan 29, 2019
@larsoner larsoner deleted the xref branch January 29, 2019 20:52
@agramfort
Copy link
Member

agramfort commented Jan 29, 2019 via email

DimitriPapadopoulos added a commit to DimitriPapadopoulos/mne-python that referenced this pull request Mar 22, 2023
`Forward` keys added by:
* 6d84371 / mne-tools#5840 / 2019-01-29

`SourceMorph` keys added by:
* 6d84371 / mne-tools#5840 / 2019-01-29
* b65a045 / mne-tools#6046 / 2019-09-15
DimitriPapadopoulos added a commit to DimitriPapadopoulos/mne-python that referenced this pull request Mar 22, 2023
dictionary key `name` repeated with different values

`Forward` keys added by:
* 6d84371 / mne-tools#5840 / 2019-01-29

`SourceMorph` keys added by:
* 6d84371 / mne-tools#5840 / 2019-01-29
* b65a045 / mne-tools#6046 / 2019-09-15
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