Skip to content

Commit d193166

Browse files
teonbrooksdrammock
andauthored
Update docstring to reflect default setting in annotations (#13304)
Co-authored-by: Daniel McCloy <dan@mccloy.info>
1 parent 2e677b1 commit d193166

File tree

4 files changed

+4
-3
lines changed

4 files changed

+4
-3
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@
164164
"mne_bids": ("https://mne.tools/mne-bids/stable", None),
165165
"mne-connectivity": ("https://mne.tools/mne-connectivity/stable", None),
166166
"mne-gui-addons": ("https://mne.tools/mne-gui-addons", None),
167-
"picard": ("https://pierreablin.github.io/picard/", None),
167+
"picard": ("https://mind-inria.github.io/picard/", None),
168168
"eeglabio": ("https://eeglabio.readthedocs.io/en/latest", None),
169169
"pybv": ("https://pybv.readthedocs.io/en/latest", None),
170170
}

doc/links.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
.. _`MNE-ICAlabel`: https://github.com/mne-tools/mne-icalabel
2727
.. _`MNE-Connectivity`: https://github.com/mne-tools/mne-connectivity
2828
.. _`MNE-NIRS`: https://github.com/mne-tools/mne-nirs
29-
.. _PICARD: https://pierreablin.github.io/picard/
29+
.. _PICARD: https://mind-inria.github.io/picard/
3030
.. _OpenMEEG: https://openmeeg.github.io
3131
.. _openneuro-py: https://pypi.org/project/openneuro-py
3232
.. _EOSS2: https://chanzuckerberg.com/eoss/proposals/improving-usability-of-core-neuroscience-analysis-tools-with-mne-python

mne/annotations.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,7 @@ def to_data_frame(self, time_format="datetime"):
597597
Parameters
598598
----------
599599
%(time_format_df_raw)s
600+
Default is ``datetime``.
600601
601602
.. versionadded:: 1.7
602603

mne/utils/docs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4629,7 +4629,7 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
46294629
remain as float values in seconds. If ``'ms'``, time values will be rounded
46304630
to the nearest millisecond and converted to integers. If ``'timedelta'``,
46314631
time values will be converted to :class:`pandas.Timedelta` values. {}
4632-
Default is ``None``.
4632+
Default is ``None`` unless specified otherwise.
46334633
"""
46344634

46354635
docdict["time_format_df"] = _time_format_df_base.format("")

0 commit comments

Comments
 (0)