Skip to content
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

Update rust.md #205

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

DrewRidley
Copy link

Made documentation a bit more clear on how cargo component works

Made documentation a bit more clear on how cargo component works
@@ -19,7 +19,7 @@ Create a Rust library that implements the `add` function in the [`example`
world](https://github.com/bytecodealliance/component-docs/tree/main/component-model/examples/example-host/add.wit). First scaffold a project:

```sh
$ cargo component new add --lib && cd add
$ cargo component new adder --lib && cd adder
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this might cause cascading changes further down (e.g. line 74). Could you say a bit more about the unclearness you ran into and/or how this would have helped you? Thanks!

@vados-cosmonic
Copy link
Contributor

Hey thanks for this suggestion @DrewRidley -- since I just added some changes related to the Rust code, I incorporated these changes here over in #222 so hopefully they're a bit clearer!

@itowlson please feel free to take a look there as well if you can find the time -- The guide should still read well, and I tried to maintain consistency. Many of the places where we mentioned add (as the project name/in a folder), should generally say adder now. The rust code actually never had a file called add.rs or anything like that, but I believe there were one or two places where we referenced the WIT dir (i.e. adder/wit).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants