[MRG] Strip base directory name from Report captions when using parse_folder#7986
Merged
agramfort merged 3 commits intomne-tools:masterfrom Jul 9, 2020
Merged
[MRG] Strip base directory name from Report captions when using parse_folder#7986agramfort merged 3 commits intomne-tools:masterfrom
agramfort merged 3 commits intomne-tools:masterfrom
Conversation
When using `Report.parse_folder()`, including the "base directory" (i.e., folder name) in all captions's unnecessarily redundant and impairs legibility. This commit changes the behavior of `Report` such that when `parse_folder()` is used, the base directory name will be stripped from the captions.
agramfort
approved these changes
Jul 9, 2020
Member
|
Can you touch |
Member
Author
Good idea |
larsoner
reviewed
Jul 9, 2020
tutorials/misc/plot_report.py
Outdated
| ############################################################################### | ||
| # With the context manager, the updated report is also automatically saved | ||
| # back to :file:`report.h5` upon leaving the block. | ||
| # This line needs to be removed. |
Member
There was a problem hiding this comment.
FYI instead of doing this, which will require another commit (and another round of CIs), it's better to either improve the wording/tutorial in some way, or (if you can't easily find an improvement) do some harmless (PEP8-compatible) newline removal or insertion.
Member
There was a problem hiding this comment.
Also in a commit where all you care about is Circle running, it helps to do [skip travis] in the commit message since Travis is usually our CI bottleneck (and Azure doesn't have an equivalent)
Member
This reverts commit 771a5fe.
Member
|
thx @hoechenberger |
larsoner
added a commit
to larsoner/mne-python
that referenced
this pull request
Jul 14, 2020
* upstream/master: (21 commits) MRG: Add SSP projectors to Report (mne-tools#7991) BUG: Fix warning (mne-tools#8006) WIP: TFR Doc/test changes (mne-tools#7998) MAINT: Remove numpydoc test on 3.6 (mne-tools#8005) MAINT: Better error message for mismatch (mne-tools#8007) MRG: Allow removal of active projectors if channels they applied to have meanwhile been dropped (mne-tools#8003) MRG Freesurfer coordinate frame tutorial (mne-tools#7578) FIX: Fix stockwell checks (mne-tools#7996) MRG, ENH: Add array-spacing plugin and reorganize deps (mne-tools#7997) MRG, ENH: Reduce memory usage of Welch PSD (mne-tools#7994) STY: One more [ci skip] STY: Docstyle [ci skip] Report parsing (mne-tools#7990) MRG, ENH: BrainVision impedance parsing (mne-tools#7974) BUG: Fix missing source space points (mne-tools#7988) [MRG] Strip base directory name from Report captions when using parse_folder (mne-tools#7986) DOC: Update estimates [skip travis] (mne-tools#7987) DOC: Try to improve find_bad_channels_maxwell doc (mne-tools#7982) VIZ, BUG: fix tickmarks in evoked topomap colorbar (mne-tools#7980) Add low-pass filter to find_bad_channels_maxwell() (mne-tools#7983) ...
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this implement/fix?
When using
Report.parse_folder(), including the "base directory" (i.e., folder name) in all captions's unnecessarily redundant and impairs legibility. This commit changes the behavior ofReportsuch that whenparse_folder()is used, the base directory name will be stripped from the captions.masterPR branch