-
Notifications
You must be signed in to change notification settings - Fork 18
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
📚Improve documentation - rework getting-started notebook. #1540
Conversation
step 1
🧙 Sourcery has finished reviewing your pull request! Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.
beste joris, kan ik hier nu nog meer in editen, of moet het stap voor stap? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1540 +/- ##
=======================================
+ Coverage 88.6% 88.8% +0.1%
=======================================
Files 107 109 +2
Lines 5128 5245 +117
Branches 962 983 +21
=======================================
+ Hits 4544 4658 +114
Misses 468 468
- Partials 116 119 +3 ☔ 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.
We should consistently use framework
instead of library
to prevent confusion.
Added (temporary) installation guide Move usage notice out of README
The requested changes were made (by me)
If they installed it already they don't need the guide :P
Slight rewording of installations instructions Added initial commit to changelog
And quickstart_project to my_project
Added plot config
Small simplification in model
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.
Thanks for motivating us to improve the readme and the docs!
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.
Very nice improvements to the docs that were long overdue 🚀
And more SEO optimization
Quality Gate passedIssues Measures |
Some minor updates to the readme to better reflect where we currently stand.
@jsnel reworked the getting-started notebook, and improved the installation instructions in the docs