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

docs: 🚨 Fix formatting issues in documentation #1364

Merged
merged 4 commits into from
Jun 17, 2024
Merged

docs: 🚨 Fix formatting issues in documentation #1364

merged 4 commits into from
Jun 17, 2024

Conversation

Anselmoo
Copy link
Owner

@Anselmoo Anselmoo commented Jun 17, 2024 •
edited by sourcery-ai bot
Loading

All PR-Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open
    Pull Requests for the same
    update/change?

New ✨✨ Feature-Submissions:

  • Does your submission pass tests?
  • Have you lint your code locally prior to submission? Fixed:
  • This PR is for a new feature, not a bug fix.

Changes to ⚙️ Core-Features:

  • Have you added an explanation of what your changes do and why you'd like
    us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully run tests with your changes locally?

Summary by Sourcery

This pull request addresses formatting issues in the statistics documentation by re-adding previously removed footnotes with proper formatting.

  • Documentation:
    • Fixed formatting issues in the statistics documentation by re-adding footnotes with proper formatting.

@Anselmoo Anselmoo enabled auto-merge (squash) June 17, 2024 04:01
@semanticdiff-com SemanticDiff.com
Copy link

Review changes with SemanticDiff.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 17, 2024
@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Jun 17, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request addresses formatting issues in the documentation by reordering and adding comments to footnotes to prevent automatic formatting tools from altering them.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

sourcery-ai[bot]
sourcery-ai bot reviewed Jun 17, 2024
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

docs/doc/statistics.md
@@ -320,10 +320,6 @@ sp.solver_model(
)
```

[^1]: requires a strictly postive `y_true` and `y_pred` array
Copy link
Contributor

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
Copy link
Contributor

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 Codecov
Copy link

codecov bot commented Jun 17, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f577a1d) to head (c8cba12).

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #1364   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           44        44           
  Lines         4467      4467           
=========================================
  Hits          4467      4467
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@github-actions github-actions bot added the github-actions Pull requests that update Github_actions code label Jun 17, 2024
@Anselmoo Anselmoo disabled auto-merge June 17, 2024 04:07
@Anselmoo Anselmoo enabled auto-merge (squash) June 17, 2024 04:07
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@Anselmoo Anselmoo merged commit 9dd8059 into main Jun 17, 2024
33 checks passed
@Anselmoo Anselmoo deleted the fix-prettier branch June 17, 2024 04:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation github-actions Pull requests that update Github_actions code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Anselmoo