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.

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

Small documentation-related fixes #226

Merged
merged 5 commits into from
Nov 17, 2023
Merged

Small documentation-related fixes #226

merged 5 commits into from
Nov 17, 2023

Conversation

billbrod
Copy link
Collaborator

  • Rename "modules" to "API Documentation" in docs, which is more stanard
  • Adds urlchecker action, to make sure all our urls are valid

Copy link

codecov bot commented Nov 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a49148c) 86.82% compared to head (e7fcd2e) 86.82%.

❗ Current head e7fcd2e differs from pull request most recent head 7270f30. Consider uploading reports for the commit 7270f30 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #226   +/-   ##
=======================================
  Coverage   86.82%   86.82%           
=======================================
  Files          35       35           
  Lines        3346     3346           
=======================================
  Hits         2905     2905           
  Misses        441      441           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

There are some failing urls that aren't actual failures, which are
in the cached output of jupyter notebooks. I want them to only check in
the input, but that's not working. so it goes
@billbrod
Copy link
Collaborator Author

billbrod commented Nov 17, 2023

The check_urls action is not required for merge, because it also checks outputs of the jupyter notebooks, which we can't guarantee to be available. In particular, it includes a message from pytorch saying it's downloading from a specific url which you can't access yourself directly. So need to remember to check it manually.

@billbrod billbrod merged commit 8573cb2 into main Nov 17, 2023
72 of 73 checks passed
@billbrod billbrod deleted the small_fix branch November 17, 2023 20:20
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.

1 participant