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, BUG: Force keywords for verbose in short sigs #8350

Merged
merged 2 commits into from
Oct 7, 2020

Conversation

larsoner
Copy link
Member

@larsoner larsoner commented Oct 7, 2020

Closes #8258
Closes #8263

@larsoner larsoner added the backport-candidate on-merge: backport to maint/1.7 label Oct 7, 2020
@hoechenberger
Copy link
Member

Great!!

@hoechenberger
Copy link
Member

Rendered API doc is now even messier than before, though:

Screenshot 2020-10-07 at 19 33 06

https://22643-1301584-gh.circle-artifacts.com/0/dev/generated/mne.Epochs.html

@hoechenberger hoechenberger merged commit 09513aa into mne-tools:master Oct 7, 2020
@larsoner larsoner deleted the kwonly branch October 7, 2020 18:00
@larsoner
Copy link
Member Author

larsoner commented Oct 7, 2020

Argh, that's the Sphinx tuple rendering bug...

larsoner added a commit that referenced this pull request Oct 7, 2020
* BUG: Force keywords for verbose in short sigs

* FIX: Doc
@larsoner
Copy link
Member Author

larsoner commented Oct 7, 2020

backported

@larsoner larsoner added backported and removed backport-candidate on-merge: backport to maint/1.7 labels Oct 7, 2020
@hoechenberger
Copy link
Member

Argh, that's the Sphinx tuple rendering bug...

Yep, and now with the * for kw-only args it looks even more hideous :D

@larsoner
Copy link
Member Author

larsoner commented Oct 7, 2020

Looks like the sphinx bug was fixed 4 days ago so hopefully it lands in some pre-release soon

@larsoner
Copy link
Member Author

larsoner commented Oct 7, 2020

sphinx-doc/sphinx#8265

@hoechenberger
Copy link
Member

Super good!!!

marsipu pushed a commit to marsipu/mne-python that referenced this pull request Oct 14, 2020
* BUG: Force keywords for verbose in short sigs

* FIX: Doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restrict allowed "verbose" values, or make the verbose kwarg a keyword-only argument?
2 participants