Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various documentation build warnings and broken links #1472

Merged
merged 7 commits into from
May 5, 2022
Merged

Fix various documentation build warnings and broken links #1472

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8b3655a
Fix broken link in gallery/advanced_io/h5dataio.py
oruebel May 5, 2022
3eb947a
Fix broken links on the extension tutorial
oruebel May 5, 2022
03ea0a3
Fix broken reference in ecephys tutorial
oruebel May 5, 2022
05d1050
Replace broken link in hdf5_io tutorial and behavior tutorial
oruebel May 5, 2022
7fe2299
Point to ndx catalog record repo for ndx-events instead of the github…
oruebel May 5, 2022
7e0d2e8
fix incorrect object ref in plot_behavior.py
weiglszonja May 5, 2022
977b4fe
Merge branch 'dev' into fix/docwarnings
bendichter May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/gallery/domain/plot_behavior.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* create an object:

* :py:class:`~pynwb.base.TimeSeries` for continuous time series data,
* :py:class:`~pynwb.base.SpatialSeries` for continuous spatial data (e.g. position, direction relative to some reference frame),
* :py:class:`~pynwb.behavior.SpatialSeries` for continuous spatial data (e.g. position, direction relative to some reference frame),
Copy link
Collaborator

Choose a reason for hiding this comment

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

We noticed some incorrect class references with @bendichter in the behavior tutorial. I thought they would fit in this PR, let me know if not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@weiglszonja sure, go ahead, feel free to add changes to this PR as you see fit. I noticed a few link issues while working on another PR, and figured I'd be a good citizen and make a PR to fix what I found.

Copy link
Collaborator

Choose a reason for hiding this comment

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

thank you!

Copy link
Collaborator

Choose a reason for hiding this comment

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

@oruebel, it is not related here, but the behavior tutorial lacks a thumbnail image. do you create these thumbnails usually for the tutorials?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I opened #1473 to make the thumbnail. I use the PowerPoint file at pynwb/docs/source/figures/gallery_thumbnails.pptx to create the thumbnails and then export as PNG. This may not be the optimal workflow, but its simple and keeps all thumbnails in one place where we can edit them.

* :py:class:`~pynwb.misc.IntervalSeries` or :py:class:`~pynwb.epoch.TimeIntervals` for time intervals

* store that object inside a behavior interface object:
Expand Down Expand Up @@ -284,7 +284,7 @@
####################
# Using :py:class:`~pynwb.epoch.TimeIntervals` representing time intervals
# is often preferred over :py:class:`~pynwb.behavior.BehavioralEpochs` and :py:class:`~pynwb.misc.IntervalSeries`.
# :py:class:`~pynwb.epoch.TimeIntervals` is a subclass of :py:class:`~pynwb.core.DynamicTable` which offers
# :py:class:`~pynwb.epoch.TimeIntervals` is a subclass of :py:class:`~hdmf.common.table.DynamicTable` which offers
# flexibility for tabular data by allowing the addition of optional columns which are not defined in the standard.
#
# Create a :py:class:`~pynwb.epoch.TimeIntervals` object that represents the time
Expand Down