diff --git a/CHANGELOG.md b/CHANGELOG.md index e0b1f9c..275dc4e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -148,7 +148,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [13.0.0-alpha.1](https://github.com/XAMPPRocky/tokei/compare/v13.0.0-alpha.0...v13.0.0-alpha.1) - 2024-03-04 ### Fixed -- fixed language names not showing when in Light mode (light background ([#1048](https://github.com/XAMPPRocky/tokei/pull/1048)) +- fixed language names not showing when in Light mode (light background) ([#1048](https://github.com/XAMPPRocky/tokei/pull/1048)) ### Other - Create release-plz.yaml @@ -227,7 +227,7 @@ Tokei 12 comes with some of the biggest user facing changes since 1.0, now in the latest version tokei will now **analyse and count multiple languages embedded in your source code** as well as adding support for **Jupyter Notebooks**. Now for the first time is able to handle and display -different languages contained in a single source file. This currently available +different languages contained in a single source file. This is currently available for a limited set of languages, with plans to add more support for more in the future. The currently supported languages are; @@ -471,13 +471,13 @@ notable that `scc` takes nearly 3x as long to complete on smaller codebases - [Tokei's README has been translated to chinese.](https://github.com/chinanf-boy/tokei-zh#tokei-) - `LanguageType` now implements `Hash`. -- Tokei now batches it's console output, this should result in a small +- Tokei now batches its console output, this should result in a small performance boost. - There is now a `--columns` argument for manually setting tokei's output width. - The `--sort` argument is now case-insensitive. - Tokei will now mark languages who's files failed to parse correctly as potentially inaccurate. -- Due to a bug in trust-ci `x86_64-unknown-netbsd` versions are will not be +- Due to a bug in trust-ci `x86_64-unknown-netbsd` versions will not be available in GitHub releases. (You will still be able to install from source.) - Due to toml-rs's lacking enum support the TOML output option has been disabled. diff --git a/README.md b/README.md index 018749a..7602aac 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Tokei is a program that displays statistics about your code. Tokei will show the - Tokei has huge range of languages, supporting over **150** languages, and their various extensions. -- Tokei can output in multiple formats(**CBOR**, **JSON**, **YAML**) +- Tokei can output in multiple formats (**CBOR**, **JSON**, **YAML**) allowing Tokei's output to be easily stored, and reused. These can also be reused in tokei combining a previous run's statistics with another set. @@ -290,7 +290,7 @@ Tokei's URL scheme is as follows. https://tokei.rs/b1/{host: values: github|gitlab}/{Repo Owner eg: XAMPPRocky}/{Repo name eg: tokei} ``` -By default the badge will show the repo's LoC(_Lines of Code_), you can also +By default the badge will show the repo's LoC (_Lines of Code_), you can also specify for it to show a different category, by using the `?category=` query string. It can be either `code`, `blanks`, `files`, `lines`, `comments`, Example show total lines: diff --git a/fuzz/README.md b/fuzz/README.md index adfcdcf..f245373 100644 --- a/fuzz/README.md +++ b/fuzz/README.md @@ -8,7 +8,7 @@ To launch a fuzzing job: `cargo +nightly fuzz run ` - it will run until To use multiple cores: `cargo +nightly fuzz run --jobs=6` -To speed things up (at the expensive of missing bugs that only manifest in larger files): +To speed things up (at the expense of missing bugs that only manifest in larger files): `cargo +nightly fuzz run -- -max_len=200` Available fuzz targets: diff --git a/src/config.rs b/src/config.rs index 82dcd8a..c9a64ef 100644 --- a/src/config.rs +++ b/src/config.rs @@ -52,7 +52,7 @@ pub struct Config { /// Whether to output only the paths for downstream batch processing /// *Default:* false #[serde(skip)] - /// adds a closure for each function, e.g., print the result + /// Adds a closure for each function, e.g., print the result pub for_each_fn: Option, } @@ -140,7 +140,7 @@ impl Config { } /* -/// Configuration for a individual [`LanguageType`]. +/// Configuration for an individual [`LanguageType`]. /// /// ``` /// use std::collections::HashMap; diff --git a/src/language/languages.rs b/src/language/languages.rs index 2b0fc58..87a749a 100644 --- a/src/language/languages.rs +++ b/src/language/languages.rs @@ -64,7 +64,7 @@ impl Languages { /// provided by [`Language`]. /// /// Takes a `&[&str]` of paths to recursively traverse, paths can be - /// relative, absolute or glob paths. a second `&[&str]` of paths to ignore, + /// relative, absolute or glob paths. A second `&[&str]` of paths to ignore, /// these strings use the `.gitignore` syntax, such as `target` /// or `**/*.bk`. ///