-
Notifications
You must be signed in to change notification settings - Fork 190
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
[Book] Add macro reference section #555
Comments
We have discussed this, and it was intended for the under the hood section (its partly there but commented out). On the one hand its valuable for a developer to understand what to expect from he macros, but on the hand this should not be necessary for using RTIC. Moreover, it would just reflect the current implementation and has no stability guarantees. We aim to provide a separate design document, explaining the current implementation and soundness considerations. Intended to 1) make it easier to contribute to RTIC, 2) as a foundation for potential certification. We will return to this after releasing 0.6. |
As a user just starting to use the project (0.6.0-rc.4), let me start by saying I love the work you're doing! This project makes developing on embedded so modular and breezy, I am excited to contribute.
Now, the issue: the
#[app]
macro is too opaque. I feel right now in order to figure out the behavior of the rtic macros, users must look at rtic's source code and usecargo-expand
.This is far from an ideal UX and could be solved by maintaining a "macro reference" document (in the book or elsewhere) that would answer the following common questions ([n] refers to a comment in code sample below):
#[init]
and#[task]
do to my functions?init
module?init::Context
?init::Context.core
, what is the shape of that structure?foo
module?foo::Context
?monotonics
module?Click to see code sample
The text was updated successfully, but these errors were encountered: