mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

DOC: 2019-09 documentation TODO list

Open drammock opened this issue 4 years ago • 3 comments

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?

  • [x] #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 (#6852)
  • [x] #6321 some missing glossary entries
  • [x] ~~#5630 add a prominent download button to the "installing MNE-C" page~~ YAGNI
  • [x] 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 #3358) done in #8570
  • [x] ICA tutorial: should apply baseline before plot_joint of artifacts (#6880)

medium difficulty?

  • [x] #6431 better description (and literature reference) in dipole fitting example
  • [x] #1857 explain SNR estimation better (where?)
  • [x] 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)
  • [ ] #6266 advanced git page
  • [ ] #3257 make a screencast of the coregistration GUI in action and add it to the docs (as a tutorial?)
  • [x] ~~#2847 improve docs for the connectivity module (@adonunes?)~~ mne_connectivity now a separate package
  • [ ] #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.
  • [x] ~~Add a tutorial for Granger analysis using nipy (#3548)~~ this falls under mne_connectivity now
  • [ ] Document risks of whitening with multiple SSS runs (#1902)

probably need some discussion / consensus-building first:

  • [x] #6792 better visibility / discoverability for the algorithms pages (closed by #6809)
  • [x] #3465 improved docs around transforming between different coord. systems (done in #7578)
  • [ ] #6778 the "cookbook" should be either converted to a tutorial, or its contents should get divvied up among existing tutorials / other doc pages
  • [ ] #3669 and #5937 discuss updates to the "flow diagram"

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

  • [x] #1495

drammock avatar Sep 19 '19 22:09 drammock

@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

larsoner avatar Dec 01 '20 19:12 larsoner

none of these are blockers for 0.22 IMO.

drammock avatar Dec 01 '20 21:12 drammock

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

larsoner avatar Oct 22 '21 21:10 larsoner