-
Notifications
You must be signed in to change notification settings - Fork 7
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: 🚨 Fix formatting issues in documentation #1364
Conversation
Review changes with SemanticDiff. |
Reviewer's Guide by SourceryThis pull request addresses formatting issues in the documentation by reordering and adding comments to footnotes to prevent automatic formatting tools from altering them. Tips
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @Anselmoo - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
@@ -320,10 +320,6 @@ sp.solver_model( | |||
) | |||
``` | |||
|
|||
[^1]: requires a strictly postive `y_true` and `y_pred` array |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (documentation): Typo in 'postive', should be 'positive'.
Please correct the typo 'postive' to 'positive' in the footnote.
docs/doc/statistics.md
Outdated
@@ -363,3 +359,9 @@ | |||
[23]: | |||
https://scikit-learn.org/stable/modules/generated/sklearn.metrics.d2_absolute_error_score.html | |||
[24]: https://jupyter.org/ | |||
|
|||
<!-- prettier-ignore --> | |||
[^1]: requires a strictly postive `y_true` and `y_pred` array |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (documentation): Typo in 'postive', should be 'positive'.
Please correct the typo 'postive' to 'positive' in the footnote.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1364 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 44 44
Lines 4467 4467
=========================================
Hits 4467 4467
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
All PR-Submissions:
Pull Requests for the same
update/change?
New ✨✨ Feature-Submissions:
Changes to ⚙️ Core-Features:
us to include them?
Summary by Sourcery
This pull request addresses formatting issues in the statistics documentation by re-adding previously removed footnotes with proper formatting.