DOC: 2019-09 documentation TODO list

[drammock]

In preparation for the Sept/Oct code sprint in Woods Hole, here is a list of TODO items for the documentation. This is not a complete list, but hopefully everyone can find one documentation item to work on during the week.

probably fairly easy?

• DOC: Clearer error message for bad events (tuple) #6455 need clearer error message when output of events_from_annotations (a tuple of events array + event_id dict) is passed to Epochs constructor as if it were just an events array (MRG +1: better error when events is tuple (closes #6455) #6852)
• DOC: glossary enhancements #6321 some missing glossary entries
• easy to find mne-c commands download button. #5630 add a prominent download button to the "installing MNE-C" page YAGNI
• Somewhere in our discussion of freesurfer/fsaverage we should link to this page. Probably a good place is on the fsaverage entry of the datasets page (hat tip to ENH: Tutorial on coreg #3358) done in DOC: fix crossrefs; add fsaverage details link #8570
• ICA tutorial: should apply baseline before plot_joint of artifacts (FIX: fix baseline correction for EOG and ECG #6880)

medium difficulty?

• DOC improve description of dipole_fit procedure #6431 better description (and literature reference) in dipole fitting example
• ENH: improve doc for SNR estimate #1857 explain SNR estimation better (where?)
• A better tutorial for make_bem_watershed. And what to do with the error that one surface intersects with another. (sort of a freesurfer problem)
• DOC, TODO: advanced dev docs #6266 advanced git page
• ENH: Screencast of coreg #3257 make a screencast of the coregistration GUI in action and add it to the docs (as a tutorial?)
• DOC: connectivity module #2847 improve docs for the connectivity module (@AdoNunes?) mne_connectivity now a separate package
• ENH/DOC: apply ICA for EEG and MEG #3849 sequential application of separate ICAs for EEG/MEG: add to tutorial?
• Add an example of how to grand average source data. (there seems to be a function for evoked and TF data but not for source). Maybe by morphing them creating a multidimensional matrix np.array and doing the average manually.
• Add a tutorial for Granger analysis using nipy (ENH: granger #3548) this falls under mne_connectivity now
• Document risks of whitening with multiple SSS runs (FIX: whitening issue when combining runs #1902)

probably need some discussion / consensus-building first:

• DOC, RFC: better visibility for "algorithms" pages #6792 better visibility / discoverability for the algorithms pages (closed by MRG, DOC: Restore I/O content via new "tutorials" #6809)
• Transform docs and API #3465 improved docs around transforming between different coord. systems (done in MRG Freesurfer coordinate frame tutorial #7578)
• DOC: Incorporate/revise cookbook.rst #6778 the "cookbook" should be either converted to a tutorial, or its contents should get divvied up among existing tutorials / other doc pages
• DOC: Updating the MNE workflow image? #3669 and DOC: single entry point and linear path through tutorials #5937 discuss updates to the "flow diagram"

earlier versions of checklists like this one (click through if all the good ones above are taken 🙂):

• FIX/DOC: Documentation #1495

[larsoner]

@drammock feel free to look through here and mark any you think are needed for 0.22 if we do manage to release in the next two weeks

[drammock]

none of these are blockers for 0.22 IMO.

[larsoner]

@drammock I'll let you decide if any of these are 0.24-block-worthy, feel free to bump if none are