enhance documentation of caching, continuation of #914 #918
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -20,7 +20,7 @@ | |||
|
|
|||
| - We removed the `Execution` section from configuration options documentation and | |||
| replaced it with new, more explicit sections (namely, Caching, Parallelization, | |||
| Logging, and Error handling). (#914 by @hoechenberger) | |||
| Logging, and Error handling), and enhanced documentation. (#914 by @hoechenberger, #916 by @SophieHerbst) | |||
There was a problem hiding this comment.
Suggested change
| Logging, and Error handling), and enhanced documentation. (#914 by @hoechenberger, #916 by @SophieHerbst) | |
| Logging, and Error handling), and enhanced documentation. (#914, #916 by @hoechenberger and @SophieHerbst) |
|
While we're talking caching … I would love to have all those parameters named Thoughts? |
Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>
|
Okay with me, I doubt they are widely used and we can avoid issues by explicitly disallowing the old names: |
|
Just adding a cross-ref to #916 since once we document the command-line options we should ideally cross-link the |
|
Thanks @SophieHerbst ! |
larsoner
added a commit
to larsoner/mne-bids-pipeline
that referenced
this pull request
Apr 16, 2024
* upstream/main: change default for info to use for inverse mne-tools#905 (mne-tools#919) Improve documentation and config validation of `loose` and `depth` parameters; drop support for `loose=None` (mne-tools#915) enhance documentation of caching, continuation of mne-tools#914 (mne-tools#918) [pre-commit.ci] pre-commit autoupdate (mne-tools#917) Restructure configuration options documentation sections (mne-tools#914) Try to fix documentation deployment (mne-tools#913) Do not show `Annotated` types in configuration options documentation (mne-tools#911) Add number of subjects to grand-average report (cont'd) (mne-tools#910) MAINT: Ensure input changes cause output changes (mne-tools#904) Render type annotations in the documentation again (mne-tools#909)
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before merging …
docs/source/changes.md)