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

DOC: Morlet wavelet length in tfr_morlet #12073

Merged
merged 14 commits into from
Oct 6, 2023
Merged

Conversation

ruuskas
Copy link
Contributor

@ruuskas ruuskas commented Oct 4, 2023

Closes #11645.

This PR adds clarification of the Morlet wavelet temporal window length used with mne.time_frequency.tfr_array_morlet and mne.time_frequency.tfr_morlet.

ruuskas and others added 2 commits October 4, 2023 23:52
This change improves the docstring of mne.time_frequency.tfr_morlet and
mne.time_frequency.tfr_array_morlet. An explanation on the length of the
Morlet wavelet for time-frequency representation is added. Closes mne-tools#11645
.
@larsoner
Copy link
Member

larsoner commented Oct 4, 2023

FYI CircleCI will fail with a warning about bool builting linking until #12068 is merged

@ruuskas ruuskas changed the title Morletdoc DOC: Morler wavelet length in tfr_morlet Oct 4, 2023
@ruuskas ruuskas changed the title DOC: Morler wavelet length in tfr_morlet DOC: Morlet wavelet length in tfr_morlet Oct 4, 2023
@larsoner
Copy link
Member

larsoner commented Oct 5, 2023

Looks like there is a failure in mne/tests/test_docstring_parameters.py::test_docdict_order

  +  'temporal-window_tfr_morlet_notes',
     'temporal-window_tfr_multitaper_notes',
  -  'temporal-window_tfr_morlet_notes',

i.e. it's no longer alphabetical

@ruuskas
Copy link
Contributor Author

ruuskas commented Oct 5, 2023

The robots seem to be happy, how about the humans? @drammock

Copy link
Member

@drammock drammock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very nice! A few minor formatting tweaks; I'm not 100% sure that all of the extra blank lines are necessary (but at least some of them are). Let's double-check the rendered docs again after rebuild.

mne/utils/docs.py Outdated Show resolved Hide resolved
mne/time_frequency/tfr.py Outdated Show resolved Hide resolved
mne/utils/docs.py Outdated Show resolved Hide resolved
mne/time_frequency/tfr.py Outdated Show resolved Hide resolved
mne/time_frequency/multitaper.py Outdated Show resolved Hide resolved
mne/utils/docs.py Outdated Show resolved Hide resolved
ruuskas and others added 7 commits October 5, 2023 16:20
Co-authored-by: Daniel McCloy <[email protected]>
Co-authored-by: Daniel McCloy <[email protected]>
Co-authored-by: Daniel McCloy <[email protected]>
Co-authored-by: Daniel McCloy <[email protected]>
Co-authored-by: Daniel McCloy <[email protected]>
@ruuskas
Copy link
Contributor Author

ruuskas commented Oct 6, 2023

Seems that the CIs failing are unrelated @drammock (?)

@drammock
Copy link
Member

drammock commented Oct 6, 2023

Seems that the CIs failing are unrelated @drammock (?)

yes definitely unrelated, however the rendering still squashes the paragraphs together; @larsoner is looking into it.

@drammock drammock enabled auto-merge (squash) October 6, 2023 10:22
@larsoner
Copy link
Member

larsoner commented Oct 6, 2023

Marking for merge when green, thanks @ruuskas !

@drammock drammock merged commit 5f7c9b9 into mne-tools:main Oct 6, 2023
28 checks passed
larsoner added a commit to larsoner/mne-python that referenced this pull request Oct 10, 2023
* upstream/main: (37 commits)
  Use constrained layout in matplotlib visualization (mne-tools#12050)
  Add raw stc (mne-tools#12001)
  [MRG] update codeowners (mne-tools#12089)
  DOC: Morlet wavelet length in tfr_morlet (mne-tools#12073)
  BUG: Fix bug with mne browser backend (mne-tools#12078)
  Cache avatars (mne-tools#12077)
  BUG: Fix bug with ch_name resolution (mne-tools#12086)
  add unicode roundtrip for FIF (mne-tools#12080)
  add Ivan to names.inc (mne-tools#12081)
  MAINT: Work around PySide 6.5.3 event loop error (mne-tools#12076)
  mne-tools#11608, buggfix and docstring update (mne-tools#12066)
  MAINT: Fix broken examples (mne-tools#12074)
  Add UI Event linking to DraggableColorbar (mne-tools#12057)
  handle lazy loading through .pyi type stubs (mne-tools#12072)
  BUG: Fix bug with sensor_colors (mne-tools#12068)
  clean  up some deprecations (mne-tools#12067)
  Allow not dropping bads when creating or plotting Spectrum objs (mne-tools#12006)
  Collapsible html repr for raw/info (mne-tools#12064)
  BUG: Fix bug with pickling MNEBadsList (mne-tools#12063)
  add details for Denis (mne-tools#12065)
  ...
snwnde pushed a commit to snwnde/mne-python that referenced this pull request Mar 20, 2024
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.

tfr_array_morlet issues with wavelet
3 participants