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

Fix few doc formatting errors #1870

Merged
merged 6 commits into from
Jul 3, 2023
Merged

Fix few doc formatting errors #1870

merged 6 commits into from
Jul 3, 2023

Conversation

SkafteNicki
Copy link
Member

@SkafteNicki SkafteNicki commented Jul 3, 2023

What does this PR do?

Fixes some documentation errors. For example look at the parameters section here:
https://torchmetrics.readthedocs.io/en/stable/references/metric.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--1870.org.readthedocs.build/en/1870/

@SkafteNicki SkafteNicki added the documentation Improvements or additions to documentation label Jul 3, 2023
@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

Merging #1870 (3a4ab1f) into master (130cb77) will increase coverage by 0%.
The diff coverage is 100%.

❗ Current head 3a4ab1f differs from pull request most recent head 663d92a. Consider uploading reports for the commit 663d92a to get more accurate results

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #1870   +/-   ##
======================================
  Coverage      87%     87%           
======================================
  Files         258     258           
  Lines       14591   14592    +1     
======================================
+ Hits        12731   12732    +1     
  Misses       1860    1860           

@mergify mergify bot added the ready label Jul 3, 2023
@justusschock justusschock enabled auto-merge (squash) July 3, 2023 13:34
@Borda Borda disabled auto-merge July 3, 2023 15:55
@Borda Borda merged commit 8bf4c94 into master Jul 3, 2023
@Borda Borda deleted the docs1 branch July 3, 2023 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants