-
-
Notifications
You must be signed in to change notification settings - Fork 91
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
Improves the docs on derive #142
Conversation
So I've done a bit of work to improve the derive docs. I do think another improvement may be to copy the style done in the tokio docs and for some simple examples show how the generated code looks. However, I think fake would benefit less from this compared to tokio (how a runtime is setup for an async application is important to more people). So it may just add unnecessary noise to the docs. I guess an issue should be made for the tuple enums - or maybe there's another way to do it I need to experiment/read-macro-code more
06a25c6
to
d68c032
Compare
I think showing the expanded code in doc not that useful. we can show more usage of the Dummy attribute,
|
For 5. how can that functionality be accessed via the derive? It's not clear from me looking at the issue and there's no related links to jump off of 👀. And sure I'll start adding these extra bits after work 👍 |
ya, item 5 might belong to general doc |
I've addressed 1, 2, 3 and 5. Looking into config vec now |
Okay added config vec into the Let me know any feedback, and as a side note any idea when the next release will go out? Would like to start using things added in my last PRs without relying on a git dep 👀 |
looks good to me. Next release will be this week. |
So I've done a bit of work to improve the derive docs.
I do think another improvement may be to copy the style done in the tokio docs and for some simple examples show how the generated code looks. However, I think fake would benefit less from this compared to tokio (how a runtime is setup for an async application is important to more people). So it may just add unnecessary noise to the docs. I've refrained from doing that but if you think it's an improvement just let me know and I can add it easily 😄
Fixes #138