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

Fix typos #800

Merged
merged 9 commits into from
Jan 16, 2025
Merged

Fix typos #800

merged 9 commits into from
Jan 16, 2025

Conversation

szepeviktor
Copy link
Contributor

Feature or Problem

Found few misspellings.

@CazJT Please consider using https://github.com/crate-ci/typos
and a language tool like DeepL Write.

@szepeviktor szepeviktor requested a review from a team as a code owner January 15, 2025 20:38
Copy link

netlify bot commented Jan 15, 2025

Deploy Preview for dreamy-golick-5f201e ready!

Name Link
🔨 Latest commit 39a4089
🔍 Latest deploy log https://app.netlify.com/sites/dreamy-golick-5f201e/deploys/67898ebc70608e0008cfbf29
😎 Deploy Preview https://deploy-preview-800--dreamy-golick-5f201e.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@markkovari
Copy link
Contributor

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 |
Copy link
Contributor

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.)

Copy link
Contributor Author

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>
Copy link
Contributor

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
Copy link
Contributor

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.)

Copy link
Contributor Author

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
Copy link
Contributor

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.

@@ -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
Copy link
Contributor

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.

@@ -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>
Copy link
Contributor

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.

Copy link
Contributor Author

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 |
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

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!

@@ -1426,7 +1426,7 @@ Generate a wasmCloud component project

###### **Options:**

- `--git <GIT>` — Github repository url. Requires 'git' to be installed in PATH
Copy link
Contributor

@ericgregory ericgregory Jan 15, 2025

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/

Copy link
Contributor Author

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reverted.

@ericgregory
Copy link
Contributor

ericgregory commented Jan 15, 2025

@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 --signoff option and push again.

In your local branch, run: git rebase HEAD~1 --signoff
Force push your changes: git push --force-with-lease origin typos

Thanks again!

@szepeviktor
Copy link
Contributor Author

Now DCO check shows a ✔️

@szepeviktor
Copy link
Contributor Author

szepeviktor commented Jan 15, 2025

wasmCloud source code has ~500 typos.
https://github.com/crate-ci/typos 👈🏻

@lachieh lachieh enabled auto-merge (rebase) January 16, 2025 22:51
auto-merge was automatically disabled January 16, 2025 22:53

Rebase failed

szepeviktor and others added 9 commits January 16, 2025 17:56
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]>
@lachieh lachieh enabled auto-merge (rebase) January 16, 2025 22:57
@lachieh lachieh merged commit 917d26d into wasmCloud:main Jan 16, 2025
4 of 5 checks passed
@szepeviktor szepeviktor deleted the typos branch January 16, 2025 22:58
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.

4 participants