-
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: 📝 docs: Update SpectraFit
documentation link and add badge
#1464
Conversation
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
Review changes with SemanticDiff. |
Reviewer's Guide by SourceryThis pull request updates the File-Level Changes
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 - 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
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1464 +/- ##
=========================================
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
Update the
SpectraFit
documentation link and add a badge to the README to indicate that the documentation is built with Material for MkDocs.Documentation:
SpectraFit
documentation link in the README.