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

better docs for permutation_cluster_test #9365

Merged
merged 7 commits into from May 3, 2021

Conversation

drammock
Copy link
Member

closes #9364

@larsoner following up on our conversation today, this should clarify the docstring at least. I also snuck in a code simplification, though I realized that the functionality for omitting adjacency along a particular dimension is already there, you just need to pass a matrix of zeros for that dimension.

@drammock drammock added the DOC label Apr 30, 2021
@larsoner
Copy link
Member

larsoner commented May 3, 2021

Doctest problem:

https://github.com/mne-tools/mne-python/pull/9365/checks?check_run_id=2479764391#step:13:3306

adding a # doctest: +NORMALIZE_WHITESPACE at the end of the offending Python call might fix it

@larsoner larsoner merged commit 68f1ec9 into mne-tools:main May 3, 2021
@larsoner
Copy link
Member

larsoner commented May 3, 2021

Thanks @drammock

larsoner added a commit to rob-luke/mne-python that referenced this pull request May 6, 2021
* upstream/main:
  MRG, ENH: Make _get_hpi_info public (mne-tools#9369)
  ENH: Add a playback button to the notebook 3d backend (mne-tools#8741)
  better docs for permutation_cluster_test (mne-tools#9365)
  MRG: Add fNIRS to html output (mne-tools#9367)
  When plotting GFP comparison in Report, don't show sensor layout by default (mne-tools#9366)
  DOC: Update Mayavi troubleshooting section (mne-tools#9362)
  more tutorial tweaks (mne-tools#9359)
larsoner added a commit to agramfort/mne-python that referenced this pull request May 10, 2021
* upstream/main:
  FIX: make epoch cropping idempotent (mne-tools#9378)
  MRG, ENH: Add NIRSport support (mne-tools#9348)
  MRG, ENH: Make _get_hpi_info public (mne-tools#9369)
  ENH: Add a playback button to the notebook 3d backend (mne-tools#8741)
  better docs for permutation_cluster_test (mne-tools#9365)
  MRG: Add fNIRS to html output (mne-tools#9367)
  When plotting GFP comparison in Report, don't show sensor layout by default (mne-tools#9366)
  DOC: Update Mayavi troubleshooting section (mne-tools#9362)
  more tutorial tweaks (mne-tools#9359)
  MRG, MAINT: Use native GitHub Actions skip (mne-tools#9361)
  MAINT: Clean up crufty code [circle front] (mne-tools#9358)
  API: Complete deprecations (mne-tools#9356)
  Add qdarkstyle, darkdetect to environment.yml [circle full] (mne-tools#9357)
  FIX: Fix
  FIX: Add
@drammock drammock deleted the adjacency-4D branch May 10, 2021 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

make it easier to specify adjacency in permutation_cluster_test
2 participants