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

docs: specify directives #2814

Merged
merged 4 commits into from
Oct 31, 2024
Merged

docs: specify directives #2814

merged 4 commits into from
Oct 31, 2024

Conversation

Borda
Copy link
Member

@Borda Borda commented Oct 31, 2024

What does this PR do?

improving reliability...
see options in https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃


📚 Documentation preview 📚: https://torchmetrics--2814.org.readthedocs.build/en/2814/

@Borda Borda merged commit d52cb48 into master Oct 31, 2024
46 of 50 checks passed
@Borda Borda deleted the docs/directives branch October 31, 2024 18:51
Copy link

codecov bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69%. Comparing base (d3894e1) to head (aa60766).
Report is 1 commits behind head on master.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #2814   +/-   ##
======================================
  Coverage      69%     69%           
======================================
  Files         344     344           
  Lines       18828   18828           
======================================
  Hits        12975   12975           
  Misses       5853    5853           

@mergify mergify bot added the ready label Oct 31, 2024
Borda added a commit that referenced this pull request Nov 7, 2024
(cherry picked from commit d52cb48)
Borda added a commit that referenced this pull request Nov 7, 2024
(cherry picked from commit d52cb48)
Borda added a commit that referenced this pull request Nov 7, 2024
(cherry picked from commit d52cb48)
Borda added a commit that referenced this pull request Nov 7, 2024
(cherry picked from commit d52cb48)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants