-
Notifications
You must be signed in to change notification settings - Fork 413
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
[guide] Remove ambiguity lib vs. executable #1649
Conversation
360b91d
to
747531f
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1649 +/- ##
=======================================
Coverage 86.45% 86.45%
=======================================
Files 696 696
Lines 81236 81236
=======================================
Hits 70233 70233
Misses 11003 11003 ☔ 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.
I have minor requests, otherwise looks good! Thanks for the change I think it will be much clearer
747531f
to
4e74593
Compare
1404cbe
to
c0c9a17
Compare
This commit transforms the guide example into a regular Rust executable so that people following the Basic Workflow in the Burn book are not surprised that the guide source does not correspond to their project. In order to maintain the possibility to use the guide source as a library like it is the case in the custom-renderer example, a lib.rs file is added with a comment at the top for users. In order to maintain the possibility to execute the guide as a regular example the examples/guide.rs has been changed to simply call cargo. The downside is that a new executable has to be compiled.
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.
LGTM
Checklist
run-checks all
script has been executed.Changes
This PR transforms the guide example into a regular Rust executable so that people following the Basic Workflow in the Burn book are not surprised that the guide source does not correspond to their project.
In order to maintain the possibility to use the guide source as a library like it is the case in the custom-renderer example, a lib.rs file is added with a comment at the top for users.
In order to maintain the possibility to execute the guide as a regular example the examples/guide.rs has been changed to simply call cargo. The downside is that a new executable has to be compiled.
Testing