Skip to content

Conversation

@larsoner
Copy link
Member

@larsoner larsoner commented May 27, 2020

Our defaut_role = 'autolink' could silently fail to link, leaving italics behind. This PR changes it to default_role = 'py:obj':

  1. We now usually don't have to prepend :py:meth: or similar to intersphinx things to link
  2. Bad links now do cause warnings (which are treated as errors) in our build

This caused me to update a bunch of docstrings that were previously rendering as italicts or errantly linking. I also changed how gen_commands.py links so that we can just do directly:

:ref:`mne what`

instead of

:ref:`gen_mne_what`

@drammock feel free to review and merge if you're happy

Copy link
Member

@drammock drammock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a bunch of things I noticed... none are blockers. I can try to chip away at these tomorrow if you don't have a chance to get back to it right away.

- Add support for :class:`numpy.random.RandomState` argument to ``seed`` in :mod:`statistical clustering functions <mne.stats>` and better documentation of exact 1-sample tests by `Eric Larson`_

- Extend :func:`mne.viz.plot_epochs_image`/:meth:`mne.Epochs.plot_image` with regards to grouping by or aggregating over channels. See the new example at `examples/visualization/plot_roi_erpimage_by_rt.py` by `Jona Sassenhagen`_
- Extend :func:`mne.viz.plot_epochs_image`/:meth:`mne.Epochs.plot_image` with regards to grouping by or aggregating over channels. See the new example at ``examples/visualization/plot_roi_erpimage_by_rt.py`` by `Jona Sassenhagen`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one could be a link to the actual doc... but these are old changelogs, not worth the trouble

@larsoner
Copy link
Member Author

Done, thanks for the look @drammock

Copy link
Member

@drammock drammock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assuming green CIs LGTM

@larsoner larsoner merged commit f641957 into mne-tools:master May 28, 2020
@larsoner larsoner deleted the default_role branch May 28, 2020 12:17
larsoner added a commit to larsoner/mne-python that referenced this pull request May 28, 2020
* upstream/master:
  MRG: Add support for foreground in _Brain (mne-tools#7843)
  MRG, MAINT: Change default role in conf.py (mne-tools#7841)
  MRG, ENH: Support n_col keyword in ica.plot_score (mne-tools#7825)
  add icons to source dist (mne-tools#7840)
  Add CZI to list of funders (mne-tools#7839)
  DOC: added reference to sesameeg package (mne-tools#7835)
  MRG, ENH: Automatically compute threshold for CTPS ECG detection (mne-tools#7819)
  MAINT: Show how picks work for planars (mne-tools#7833)
  Clearer info docstring (mne-tools#7832)
  MRG, ENH: Add estimation method legend (mne-tools#7830)
  Remove double spaces (mne-tools#7822)
  add troubleshooting message about OpenGL [skip travis] (mne-tools#7827)
  fix links [skip travis] (mne-tools#7826)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants