-
Notifications
You must be signed in to change notification settings - Fork 129
Introduce the first section of the RMC tutorial #474
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
Conversation
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.
This function might confuse people. Should we include prelude.rs instead to "hide" some of the confusion?
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 sort of, kind of, hide it already, at least in that this code doesn't actually appear in the documentation.
But yes, we need to find a good way to address this. Right now it looked like there's no good way to include the prelude! The tests we have, at any rate, have to directly refer to it by relative path.
Fixing this is probably a major developer experience issue. My thought is: fix that, then revise this sample.
I create #477 to take this as a note.
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.
Sounds good.
cad9b89 to
87da61a
Compare
zhassan-aws
left a comment
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.
Looks great!
* Introduce the first section of the RMC tutorial * add license boilerplate, correct typos * fix formatting
* Introduce the first section of the RMC tutorial * add license boilerplate, correct typos * fix formatting
Description of changes:
Add the first section of the RMC tutorial.
Resolved issues:
Progress towards #254
Call-outs:
Testing:
How is this change tested? The new little crate can
cargo testandcargo rmcandrmc tests/final-form.rs. This currently isn't in CI. That will be deferred until later.Is this a refactor change? no
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.