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

Jump to bottom

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

merged 7 commits into from
May 5, 2022

Conversation

oruebel
Copy link
Contributor

@oruebel oruebel commented May 5, 2022

Motivation

Fix various documentation build warnings and broken links

How to test the behavior?

cd docs
make linkcheck

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running flake8 from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@oruebel oruebel requested a review from rly May 5, 2022 05:45
@oruebel oruebel added category: bug errors in the code or code behavior topic: docs issues related to documentation priority: low alternative solution already working and/or relevant to only specific user(s) labels May 5, 2022
@codecov
Copy link

codecov bot commented May 5, 2022 •
edited
Loading

Codecov Report

Merging #1472 (977b4fe) into dev (ea56343) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #1472   +/-   ##
=======================================
  Coverage   77.47%   77.47%           
=======================================
  Files          37       37           
  Lines        2735     2735           
  Branches      455      455           
=======================================
  Hits         2119     2119           
  Misses        535      535           
  Partials       81       81

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ea56343...977b4fe. Read the comment docs.

weiglszonja
weiglszonja reviewed May 5, 2022
View reviewed changes
docs/gallery/domain/plot_behavior.py
@@ -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.

@bendichter bendichter self-requested a review May 5, 2022 13:57
@oruebel oruebel merged commit e348662 into dev May 5, 2022
@oruebel oruebel deleted the fix/docwarnings branch May 5, 2022 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weiglszonja weiglszonja weiglszonja left review comments

@bendichter bendichter bendichter approved these changes

@rly rly Awaiting requested review from rly

Assignees
No one assigned
Labels
category: bug errors in the code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs issues related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@oruebel @bendichter @weiglszonja