-
Notifications
You must be signed in to change notification settings - Fork 1
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
Getting Started update #774
Conversation
…st to account for the changes and have the files needed
… the examples code. Can be run from start to end from a user + works with doctest
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #774 +/- ##
=======================================
Coverage 94.98% 94.98%
=======================================
Files 109 109
Lines 5698 5700 +2
Branches 323 323
=======================================
+ Hits 5412 5414 +2
Misses 285 285
Partials 1 1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Co-authored-by: René Roos <[email protected]>
Looks good to me overall, I just added some comments regarding variable names for the example files. |
…pyacp into docs/getting_started_file
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.
Two more minor suggestions, apologies for not catching those on the first review.
Co-authored-by: Dominik Gresch <[email protected]>
Updated the Getting Started section of the documentation such that it can be done from a user (solves #771), Code to download the examples file has also been added.