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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid having typos in documentation and codebase #2396

Open
azzamsa opened this issue Jun 22, 2024 · 1 comment
Open

Avoid having typos in documentation and codebase #2396

azzamsa opened this issue Jun 22, 2024 · 1 comment

Comments

@azzamsa
Copy link

azzamsa commented Jun 22, 2024

Hi, 馃憢

Are you interested in avoiding typos in the documentation and codebase? I ran typos and found some.

Yes, sometimes it reports false positives, but typos-cli keeps improving, and it is customizable.

If you're okay with it, I'm ready to submit a PR.

error: `adressing` should be `addressing`
  --> ./iroh-net/src/lib.rs:101:53
    |
101 | //! up the [`NodeId`] in the DNS system to find the adressing details.  This enables
    |                                                     ^^^^^^^^^
    |
error: `fileystem` should be `filesystem`
  --> ./iroh-blobs/src/export.rs:40:76
   |
40 | /// Export all entries of a collection, recursively, to files on the local fileystem.
   |                                                                            ^^^^^^^^^
   |
error: `fileystem` should be `filesystem`
  --> ./iroh-blobs/src/export.rs:58:49
   |
58 | /// Export a single blob to a file on the local fileystem.
   |                                                 ^^^^^^^^^
   |
error: `conact` should be `contact`
  --> ./iroh-net/src/endpoint.rs:720:57
    |
720 |     /// known direct addresses, when there was last any conact with this node and what kind
    |                                                         ^^^^^^
    |
error: `environemnt` should be `environment`
  --> ./iroh-net/src/endpoint.rs:1041:31
     |
1041 | /// Read a proxy url from the environemnt, in this order
     |                               ^^^^^^^^^^^
     |
error: `ocurred` should be `occurred`
  --> ./iroh-blobs/src/downloader.rs:90:18
   |
90 |     /// An error ocurred that prevents the request from being retried at all.
   |                  ^^^^^^^
   |
error: `attemps` should be `attempts`
  --> ./iroh-net/src/discovery/pkarr_publish.rs:132:24
    |
132 |         let mut failed_attemps = 0;
    |                        ^^^^^^^
    |
error: `attemps` should be `attempts`
  --> ./iroh-net/src/discovery/pkarr_publish.rs:139:28
    |
139 |                     failed_attemps += 1;
    |                            ^^^^^^^
    |
error: `attemps` should be `attempts`
  --> ./iroh-net/src/discovery/pkarr_publish.rs:143:76
    |
143 |                         .reset(Instant::now() + Duration::from_secs(failed_attemps));
    |                                                                            ^^^^^^^
    |
error: `attemps` should be `attempts`
  --> ./iroh-net/src/discovery/pkarr_publish.rs:145:28
    |
145 |                     failed_attemps = 0;
    |                            ^^^^^^^
    |
error: `adress` should be `address`
  --> ./iroh-net/src/discovery.rs:63:13
   |
63 |     /// The adress info for the node being resolved.
   |             ^^^^^^
   |
error: `substituded` should be `substituted`
  --> ./iroh-net/src/bin/iroh-relay.rs:185:32
    |
185 | /// and can not immediately be substituded by serde.
    |                                ^^^^^^^^^^^
@dignifiedquire
Copy link
Contributor

thanks, would be useful to have it, as long as it doesn't add too many false positives

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

No branches or pull requests

2 participants