Skip to content

DOC: Clean up Forward and SourceSpaces #10911

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

Merged
merged 2 commits into from
Jul 13, 2022
Merged

DOC: Clean up Forward and SourceSpaces #10911

merged 2 commits into from
Jul 13, 2022

Conversation

larsoner
Copy link
Member

@larsoner larsoner commented Jul 7, 2022

Needs numpy/numpydoc#415. Removes super class stuff we don't want to document.

Perhaps we want this for Info, too, but there it's not so simple because we want the methods from some subclasses but not others.

@drammock
Copy link
Member

drammock commented Jul 7, 2022

Looks much better! Still seeing some duplicated elements though; was that supposed to be fixed?

Screenshot 2022-07-07 at 12-44-54 mne Forward — MNE 1 1 dev0 documentation

(screenshot from here: https://output.circle-artifacts.com/output/job/bf8fce80-1d84-49ec-b2de-baf13957a313/artifacts/0/dev/generated/mne.Forward.html#mne.Forward)

@larsoner
Copy link
Member Author

larsoner commented Jul 7, 2022

That duplication is standard, there is the list of methods then below it their actual definitions. See for example

https://mne.tools/dev/generated/mne.io.Raw.html

@drammock
Copy link
Member

drammock commented Jul 7, 2022

That duplication is standard

right, of course, sorry. Do we merge this, or wait for the upstream numpydoc fix?

@agramfort
Copy link
Member

No opinion here for me.

@larsoner
Copy link
Member Author

larsoner commented Jul 7, 2022

Let's wait for the upstream PR to be merged

@larsoner larsoner changed the title WIP: Clean up Forward and SourceSpaces DOC: Clean up Forward and SourceSpaces Jul 13, 2022
@larsoner larsoner merged commit 86d3c2a into mne-tools:main Jul 13, 2022
@larsoner larsoner deleted the doc branch July 13, 2022 15:21
larsoner added a commit to alexrockhill/mne-python that referenced this pull request Jul 14, 2022
* upstream/main:
  to_data_frame API change (mne-tools#10925)
  MAINT: Fix Qt issue (mne-tools#10923)
  Update inverse.rst DOC (mne-tools#10922)
  DOC: Clean up Forward and SourceSpaces (mne-tools#10911)
  [MAINT, MRG] Move sensor cluster permutation example to correct directory (mne-tools#10917)
  [MRG] Add data loader functions for BESA files (mne-tools#10892)
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.

3 participants