-
Notifications
You must be signed in to change notification settings - Fork 257
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Update readme to latest template syntax #2178
Conversation
Signed-off-by: tpmccallum tim.mccallum@fermyon.com This readme is also visible from https://crates.io/crates/spin-sdk Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
sdk/rust/README.md
Outdated
|
||
```rust | ||
use anyhow::Result; |
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.
We don't import anyhow::Result
in the example above so I would remove this and change line 45 to:
async fn handle_hello_world(_req: Request) -> anyhow::Result<impl IntoResponse> {
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.
Done!
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Co-authored-by: Ryan Levick <ryan.levick@fermyon.com> Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Co-authored-by: Ryan Levick <ryan.levick@fermyon.com> Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
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.
Hi @rylev
Agreed, the README file is limited in what it explains to the user.
I have added a section that links to the developer documentation.
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
@tpmccallum I don't see the section linking to the developer docs. Where can I find that? |
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
Oh, my apologies @rylev (and good catch). It seems the backticks stopped the text from being an inline commit (and my changes were just added as general comments). |
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.
Left one comment with something we should address but other than that looks great!
Signed-off-by: tpmccallum tim.mccallum@fermyon.com Signed-off-by: Timothy McCallum <tim.mccallum@fermyon.com>
Thanks so much for the review @rylev ; greatly appreciated!!! |
Signed-off-by: tpmccallum tim.mccallum@fermyon.com
This readme is also visible from https://crates.io/crates/spin-sdk