explain 'mode' options for mne.sensitivity_map #13382
Conversation
|
Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴 |
for more information, see https://pre-commit.ci
|
The documentation of the various |
|
thanks for the contribution! easiest way forward is probably to run |
Local pre-commit passes. The docstring is fixed. Could you please approve the CI to run? |
There's an error in the CIs that already ran, though:
If you view the CI's documentation build (by clicking "check the rendered docs here" in the list of CIs, and navigating to the sensitivity_map page), you'll see the docstring looks a bit off: You can test out your fix by changing to the When that's done, you can push your changes and the CircleCI build should succeed. Then we'll enable the other CIs :) |
mne/proj.py
Outdated
| projs : list | ||
| List of projection vectors. | ||
| ch_type : ``'grad'`` | ``'mag'`` | ``'eeg'`` | ||
| ch_type : {'grad', 'mag', 'eeg'} |
There was a problem hiding this comment.
revert this change. using | to separate parameter options is how we do it in MNE-Python (see item 3 in this section)
mne/proj.py
Outdated
| mode : {'free', 'fixed', 'ratio', 'radiality', 'angle', | ||
| 'remaining', 'dampening'}, default='free' |
There was a problem hiding this comment.
use | (see prior comment). Also, we don't list the default on this line, because users can look at the function signature to see what it is.
|
The parameter description for "mode" still looks wrong, the last 2 possibilities are blockquoted on a separate line. |
- Add detailed explanations for all mode parameter options - Clarify the difference between each sensitivity computation method - Update environment.yml dependencies Closes mne-tools#12979
NatalieNegussie97
force-pushed
the
docs/sensitivity-map-mode
branch
from
42eb8eb to
2daf592
Compare
NatalieNegussie97
requested review from
agramfort and
dengemann
as code owners
|
Hi @drammock, I’ve addressed all the issues I could find. pre-commit run --all-files now passes locally, and I built the docs locally and checked the mne.sensitivity_map page. If there’s anything I’ve missed, I’d appreciate pointers. Also, are there other checks I should run locally (beyond pre-commit) to catch “rendered docs” problems earlier? Thanks! |
drammock
dismissed
wmvanvliet’s stale review
stale (all requested changes done)
Pull request was closed
|
@NatalieNegussie97 did you mean to close this? Looks like it was marked for auto-merge so was about to get in! |
| @@ -1,82 +1,85 @@ | |||
| #!/bin/bash | |||
There was a problem hiding this comment.
... but we should git checkout upstream/main tools/get_minimal_commands.sh or so to put this file back to how it was
4 participants
Hi:)
Clarify the docstring of 'mne.sensitivity_map' to explain available 'mode' options, based on the CLI help text.
No behavioral changes, only documentation improvement.
Closes #12979.