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

[MAINT] Add docstrings to spectral time methods #128

Merged
merged 6 commits into from
Mar 6, 2023

Conversation

adam2392
Copy link
Member

PR Description

Towards: #127

@ruuskas if you have the time, would you be able to review the docstrings here to verify that they are correct?

Merge checklist

Maintainer, please confirm the following before merging:

  • All comments resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated
  • PR description includes phrase "closes <#issue-number>"

Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
@adam2392
Copy link
Member Author

adam2392 commented Mar 2, 2023

Perhaps @tsbinns you are interested in giving this a review since you're interested in spectral connectivity?

Copy link
Collaborator

@tsbinns tsbinns left a comment

Choose a reason for hiding this comment

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

Hi @adam2392, all looks good to me!

Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Copy link
Contributor

@ruuskas ruuskas left a comment

Choose a reason for hiding this comment

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

Hi @adam2392! I think MNE-Python style guidelines suggest using array-like, shape (n_freqs, n_times) instead of array-like of shape (n_freqs, n_times).

Other than that minor nitpick, this looks good to me.

@adam2392 adam2392 merged commit 2a23617 into mne-tools:main Mar 6, 2023
@adam2392 adam2392 deleted the adddoc branch March 6, 2023 20:17
tsbinns pushed a commit to tsbinns/mne-connectivity that referenced this pull request Dec 15, 2023
* Add docstrings to spectral time methods

---------
Signed-off-by: Adam Li <adam2392@gmail.com>
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