-
Notifications
You must be signed in to change notification settings - Fork 49
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
Fix typos #800
Fix typos #800
Conversation
✅ Deploy Preview for dreamy-golick-5f201e ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Ollala @szepeviktor what a small world we live in. 🤔 |
@@ -41,4 +41,4 @@ The following events are emitted on a special topic, `wasmbus.rpcevt.{lattice-id | |||
| Type | Fields | Description | | |||
| :-------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------- | | |||
| `invocation_failed` | **`source`** (`public_key`, `contract_id`, `link_name`)<br/> **`dest`** (`public_key`, `contract_id`, `link_name`) <br/>`operation`<br/> `bytes` (payload len) | An RPC failure notification | | |||
| `invocation_suceeded` | _Same as above_ | An RPC success notification | |
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.
Since this spelling error is part of the cloud event list, it shouldn't actually be corrected. (Mostly for archival purposes since this is on an old version.)
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.
Reverted.
@@ -105,7 +105,7 @@ corresponding to a clock tick.</p> | |||
</ul> | |||
<h4><a name="subscribe_instant"><code>subscribe-instant: func</code></a></h4> | |||
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the specified instant | |||
occured.</p> |
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.
The spelling errors on this page derive from (a past version of) an upstream WIT document. They shouldn't be changed because it introduces drift from the upstream. (Not that consequential in this case because it's an old version of the WIT in an older version of the docs, but as a matter of precedent.)
@@ -326,7 +326,7 @@ and stream is ready for writing again.</p> | |||
</ul> | |||
<h4><a name="method_output_stream.subscribe"><code>[method]output-stream.subscribe: func</code></a></h4> | |||
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the output-stream | |||
is ready for more writing, or an error has occured. When this |
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.
The spelling errors on this page derive from (a past version of) an upstream WIT document. They shouldn't be changed because it introduces drift from the upstream. (Not that consequential in this case because it's an old version of the WIT in an older version of the docs, but as a matter of precedent.)
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.
Reverted
- versioned_docs/version-0.82/reference/wasi/incoming-http.md
- versioned_docs/version-0.82/reference/wasi/interfaces.md
@@ -633,7 +633,7 @@ and stream is ready for writing again.</p> | |||
</ul> | |||
<h4><a id="method_output_stream_subscribe"></a><code>[method]output-stream.subscribe: func</code></h4> | |||
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the output-stream | |||
is ready for more writing, or an error has occured. When this |
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.
The spelling errors on this page derive from an upstream WIT document. They shouldn't be changed because it introduces drift from the upstream.
docs/reference/wasi/interfaces.md
Outdated
@@ -333,7 +333,7 @@ and stream is ready for writing again.</p> | |||
</ul> | |||
<h4><a id="method_output_stream_subscribe"></a><code>[method]output-stream.subscribe: func</code></h4> | |||
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the output-stream | |||
is ready for more writing, or an error has occured. When this |
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.
The spelling errors on this page derive from an upstream WIT document. They shouldn't be changed because it introduces drift from the upstream.
docs/reference/wasi/incoming-http.md
Outdated
@@ -105,7 +105,7 @@ corresponding to a clock tick.</p> | |||
</ul> | |||
<h4><a id="subscribe_instant"></a><code>subscribe-instant: func</code></h4> | |||
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the specified instant | |||
occured.</p> |
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.
The spelling errors on this page derive from an upstream WIT document. They shouldn't be changed because it introduces drift from the upstream.
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.
All three reverted.
- docs/reference/wasi/incoming-http.md
- docs/reference/wasi/interfaces.md
- docs/reference/wasi/wrpc-interfaces.md
| `invocation_suceeded` | An RPC success notification | | ||
| Type | Description | | ||
| :--------------------- | :-------------------------- | | ||
| `invocation_failed` | An RPC failure notification | |
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 should be checked against the cloud events.
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 do not know how to do that.
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 is all I've found.
https://github.com/search?q=repo%3AwasmCloud%2Fwasmcloud-otp%20invocation_succeeded&type=code
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 worries, I'll validate!
docs/cli/wash.mdx
Outdated
@@ -1426,7 +1426,7 @@ Generate a wasmCloud component project | |||
|
|||
###### **Options:** | |||
|
|||
- `--git <GIT>` — Github repository url. Requires 'git' to be installed in PATH |
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 page is derived from wash CLI help -- all corrections for this page should go to the wash CLI in the wasmCloud monorepo: https://github.com/wasmCloud/wasmCloud/
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.
In the gitattributes file you can mark these files as generated.
https://github.com/github-linguist/linguist/blob/main/docs/overrides.md#summary
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.
Reverted.
@szepeviktor Thanks for the corrections and the quick responses. There are years of accumulated typos here from lots of folks! We'll need to make sure we're not inadvertently introducing drift from some of the upstream documents we use to generate certain pages (per my comments), and it'll be helpful to open issues on those errors in the relevant sources (for the wash CLI in the wasmCloud/wasmCloud repo, for example). For the DCO check to pass, you can amend the commits with the In your local branch, run: Thanks again! |
Now DCO check shows a ✔️ |
wasmCloud source code has ~500 typos. |
Rebase failed
Signed-off-by: Viktor Szépe <[email protected]>
Signed-off-by: Viktor Szépe <[email protected]>
Co-authored-by: Eric Gregory <[email protected]> Signed-off-by: Viktor Szépe <[email protected]>
Co-authored-by: Eric Gregory <[email protected]> Signed-off-by: Viktor Szépe <[email protected]>
Co-authored-by: Eric Gregory <[email protected]> Signed-off-by: Viktor Szépe <[email protected]>
Signed-off-by: Viktor Szépe <[email protected]>
Signed-off-by: Viktor Szépe <[email protected]>
Signed-off-by: Viktor Szépe <[email protected]>
Signed-off-by: Viktor Szépe <[email protected]>
Feature or Problem
Found few misspellings.
@CazJT Please consider using https://github.com/crate-ci/typos
and a language tool like DeepL Write.