-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add a useful description to README file. #19
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #19 +/- ##
==========================================
+ Coverage 70.53% 71.02% +0.49%
==========================================
Files 6 6
Lines 526 528 +2
==========================================
+ Hits 371 375 +4
+ Misses 155 153 -2 ☔ View full report in Codecov by Sentry. |
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.
Please update the README.md accordingly and subsequently run pre-commit run docs-landing-page
to update the docs/index.md
file.
mkdocstrings
supports referencing specific Python API functions, classes, methods, etc. But the landing page/README is special, since it needs to support both GitHub and the documentation, so I'll try to ensure both renditions work, including the automatic referencing in the documentation build. (I have created issue #22 to follow up on this after this PR has been merged.)
This branch should have the latest changes from |
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Do I really have to mark all our disagreements as resolved in order to ask you for a new review? |
I mentioned only those you haven't reacted to that includes suggested changes that does not focus on the style changes. Please address these suggested changes and comments, yes. Otherwise what's the point of doing a review if it's not taken serious? |
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
I accepted most suggestions, except those changing the header style. |
Closes #18
If the mkdocs generated reference documentation is available somewhere, then a link should be added to it from the README file.