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

Epochs: Baseline-Default problems #8078

Closed
marsipu opened this issue Aug 2, 2020 · 3 comments
Closed

Epochs: Baseline-Default problems #8078

marsipu opened this issue Aug 2, 2020 · 3 comments
Milestone

Comments

@marsipu
Copy link
Member

marsipu commented Aug 2, 2020

Describe the bug

Their are two problems regarding the Baseline-Argument of the Epochs-Classes:

  1. The default-value (None, 0) is not correctly formatted by sphinx.ext.autodoc and results in "baseline=None, 0, ...
  2. Epochs-Array doesn't have the same default-value as the other Epochs-Classes (None instead of (None, 0).

Baseline_autodoc
Baseline_array

@larsoner
Copy link
Member

larsoner commented Aug 2, 2020

For EpochsArray I think that choice is intentional. If you do EpochsArray we probably shouldn't modify the array by default. For Epochs probably you want a baseline. So maybe just a .. note:: in the EpochsArray docs saying it's different from Epochs is a good choice.

For the docs of a tuple being broken, someone will have to look into it. I have a feeling numpy/numpydoc#221 or some similar refactoring in numpydoc could be to blame. If you want to try git bisect on Sphinx and/or numpydoc feel free -- if you're not up for it let me know and I'll give it a shot.

@larsoner larsoner added this to the 0.21 milestone Aug 2, 2020
@larsoner
Copy link
Member

larsoner commented Aug 4, 2020

Upstream bug filed sphinx-doc/sphinx#8052

@larsoner larsoner closed this as completed Aug 4, 2020
@marsipu
Copy link
Member Author

marsipu commented Aug 5, 2020

Thank you @larsoner, sorry, I somehow missed your response. Thanks for fixing it

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

No branches or pull requests

2 participants