-
Notifications
You must be signed in to change notification settings - Fork 67
chore(docs): Move relevant sh
codeblocks to console
#232
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
```sh | ||
wac compose composition.wac -o final.wasm | ||
wac compose composition.wac -o final.wasm |
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 think this could be console
if we're doing that!
@@ -94,7 +94,7 @@ export validator...; | |||
|
|||
Then, `wac compose` can be used to compose the components, passing in the paths to the components. Alternatively, you can place the components in a `deps` directory with an expected structure, and in the near future, you will be able to pull in components from registries. See the [`wac` documentation](https://github.com/bytecodealliance/wac) for more details. | |||
|
|||
```sh | |||
```console |
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 would be a good time to space out the command line args to different lines so the block is a bit easier to read.
@@ -79,7 +79,7 @@ working with WebAssembly modules and components. | |||
4. Use `wasm-tools` to create a component from the core module, first embedding component metadata | |||
inside the core module and then encoding the WAT to a Wasm binary. | |||
|
|||
```sh | |||
```console |
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.
If we have console
and only commands in a block, we can take out the $
, because it makes it hard to copy paste
Ditto for the other places in the PR as well!
@@ -199,7 +199,7 @@ public class AddImpl : IAdd | |||
|
|||
Once again, compile an application to a Wasm component using `dotnet build`: | |||
|
|||
```sh | |||
```console |
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.
No need to do anything here, but this actually shouldn't be a console
block IMO, because it contains the command and output.
I would normally leave this without a highlighting tag all together, but that's me.
@itowlson this is a good example of the nuance IMO -- would love to know your thoughts here.
@@ -275,7 +275,7 @@ Console.WriteLine($"{left} + {right} = {result}"); | |||
|
|||
Once again, compile your component with `dotnet build`: | |||
|
|||
```sh | |||
```console |
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.
Same note here as above w/ the combination of command and output
PR had been closed pending further discussion on using |
Move certain codeblocks that are not
sh
code toconsole
, issue: #231