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: 📝 docs: Update SpectraFit documentation link and add badge #1464

Merged
merged 1 commit into from
Aug 2, 2024

Conversation

Anselmoo
Copy link
Owner

@Anselmoo Anselmoo commented Aug 2, 2024

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:


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

Update the SpectraFit documentation link and add a badge to the README to indicate that the documentation is built with Material for MkDocs.

Documentation:

  • Update the SpectraFit documentation link in the README.
  • Add a badge to the README indicating that the documentation is built with Material for MkDocs.

Update the documentation link for `SpectraFit` to point to the extended documentation page. Also, add a badge for the Material for MkDocs library which is used to generate the documentation.

Fixes docs: Adding a mkdocs-material badge to SpectraFit #1463
@Anselmoo Anselmoo enabled auto-merge August 2, 2024 19:53
Copy link

Review changes with SemanticDiff.

Copy link
Contributor

sourcery-ai bot commented Aug 2, 2024

Reviewer's Guide by Sourcery

This pull request updates the SpectraFit documentation link in the README.md file and adds a badge for 'Material for MkDocs'. The changes are straightforward, involving the addition of a new link and badge to enhance the documentation section.

File-Level Changes

Files Changes
README.md Updated the documentation link and added a 'Material for MkDocs' badge.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • 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.

@github-actions github-actions bot added documentation Improvements or additions to documentation root labels Aug 2, 2024
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 - here's some feedback:

Overall Comments:

  • Consider using Markdown syntax instead of HTML for the badge, and possibly opt for a smaller, standard-sized badge to maintain visual consistency in the README.
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: all looks good

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.

Copy link

sonarqubecloud bot commented Aug 2, 2024

Copy link

codecov bot commented Aug 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (386edd3) to head (48b99e0).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1464   +/-   ##
=========================================
  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.

@Anselmoo Anselmoo merged commit 4c3cec3 into main Aug 2, 2024
33 checks passed
@Anselmoo Anselmoo deleted the Anselmoo/issue1463 branch August 2, 2024 20:01
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 root size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Adding a mkdocs-material badge to SpectraFit
1 participant