From d61695dd87c21d5e90186e808f3b95778241c4ba Mon Sep 17 00:00:00 2001 From: vk <89937361+itsvedantkumar@users.noreply.github.com> Date: Fri, 21 Aug 2026 13:27:44 +0530 Subject: [PATCH] docs : fix typos in readme files (#4004) Nine spelling mistakes across the main readme and seven example readmes: geneated -> generated, recieved -> received, difinitions -> definitions, continously -> continuously, ect -> etc, and "lasted"/"recommanded" -> "latest"/"recommended" in the CANN section. Found with codespell; each one read in context first. Docs only. Assisted-by: Claude (Anthropic) --- README.md | 2 +- examples/bench.wasm/README.md | 2 +- examples/command.wasm/README.md | 2 +- examples/lsp/README.md | 6 +++--- examples/stream.wasm/README.md | 2 +- examples/stream/README.md | 2 +- examples/sycl/README.md | 4 ++-- examples/whisper.wasm/README.md | 2 +- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1cd81ac3c..6ad7b5f58 100644 --- a/README.md +++ b/README.md @@ -386,7 +386,7 @@ First, check if your Ascend NPU device is supported: | Atlas 300T A2 | Support | | Atlas 300I Duo | Support | -Then, make sure you have installed [`CANN toolkit`](https://www.hiascend.com/en/software/cann/community) . The lasted version of CANN is recommanded. +Then, make sure you have installed [`CANN toolkit`](https://www.hiascend.com/en/software/cann/community) . The latest version of CANN is recommended. Now build `whisper.cpp` with CANN support: diff --git a/examples/bench.wasm/README.md b/examples/bench.wasm/README.md index 0ebf0a21f..be38c37c0 100644 --- a/examples/bench.wasm/README.md +++ b/examples/bench.wasm/README.md @@ -44,4 +44,4 @@ cp bin/libbench.worker.js /path/to/html/ > 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no > longer generated and the worker is embedded in the main JS file. So the worker -> file will not be geneated for versions later than `3.1.58`. +> file will not be generated for versions later than `3.1.58`. diff --git a/examples/command.wasm/README.md b/examples/command.wasm/README.md index c50c2b43e..d134f2aed 100644 --- a/examples/command.wasm/README.md +++ b/examples/command.wasm/README.md @@ -44,4 +44,4 @@ cp bin/libcommand.worker.js /path/to/html/ > 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no > longer generated and the worker is embedded in the main JS file. So the worker -> file will not be geneated for versions later than `3.1.58`. +> file will not be generated for versions later than `3.1.58`. diff --git a/examples/lsp/README.md b/examples/lsp/README.md index b9afb1145..0caf9acc8 100644 --- a/examples/lsp/README.md +++ b/examples/lsp/README.md @@ -31,7 +31,7 @@ The vim plugin was designed to closely follow the mnemonics of vim Keys corresponding to a string use that spoken value normally and when a motion is expected, but use the key itself when a character is expected. -Keys corresponding to a dict, like `i`, can have manual difinitions given to each possible commandset. +Keys corresponding to a dict, like `i`, can have manual definitions given to each possible commandset. 0 is normal (insert), 1 is motion (inside), 2 is it's usage as a single key ([till] i), and 3 is it's usage in an area selection (s -> [around] sentence) @@ -89,7 +89,7 @@ Will return an error if any of the commands in the commandset have duplicate tok `guided` `params.commandset_index` An index returned by a corresponding commandset registration. If not set, the most recently registered commandset is used. -`params.timestamp` A positive unsigned integer which designates a point in time which audio should begin processing from. If left blank, the start point of audio processing will be the moment the message is recieved. This should be left blank unless you have a timestamp from a previous response. +`params.timestamp` A positive unsigned integer which designates a point in time which audio should begin processing from. If left blank, the start point of audio processing will be the moment the message is received. This should be left blank unless you have a timestamp from a previous response. Responds with `result.command_index` The numerical index (starting from 0) of the detected command in the selected commandset `result.command_text` A string containing the command as provided in the commandset @@ -98,7 +98,7 @@ Responds with `unguided` `params.no_context` Sets the corresponding whisper `no_context` param. Defaults to true. Might provide more accurate results for consecutive unguided transcriptions if those after the first are set to false. `params.prompt` If provided, sets the initial prompt used during transcription. -`params.timestamp` A positive unsigned integer which designates a point in time which audio should begin processing from. If left blank, the start point of audio processing will be the moment the message is recieved. This should be left blank unless you have a timestamp from a previous response. +`params.timestamp` A positive unsigned integer which designates a point in time which audio should begin processing from. If left blank, the start point of audio processing will be the moment the message is received. This should be left blank unless you have a timestamp from a previous response. Responds with `result.transcription` A string containing the transcribed text. N.B. This will almost always start with a space due to how text is tokenized. `result.timestamp` A positive unsigned integer that designates the point in time which audio stopped being processed at. Pass this timestamp back in a subsequent message to mask the latency of transcription. diff --git a/examples/stream.wasm/README.md b/examples/stream.wasm/README.md index 431555655..e2bb29d58 100644 --- a/examples/stream.wasm/README.md +++ b/examples/stream.wasm/README.md @@ -42,4 +42,4 @@ cp bin/libstream.worker.js /path/to/html/ > 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no > longer generated and the worker is embedded in the main JS file. So the worker -> file will not be geneated for versions later than `3.1.58`. +> file will not be generated for versions later than `3.1.58`. diff --git a/examples/stream/README.md b/examples/stream/README.md index f07cfb891..f10645e7e 100644 --- a/examples/stream/README.md +++ b/examples/stream/README.md @@ -1,7 +1,7 @@ # whisper.cpp/examples/stream This is a naive example of performing real-time inference on audio from your microphone. -The `whisper-stream` tool samples the audio every half a second and runs the transcription continously. +The `whisper-stream` tool samples the audio every half a second and runs the transcription continuously. More info is available in [issue #10](https://github.com/ggerganov/whisper.cpp/issues/10). ```bash diff --git a/examples/sycl/README.md b/examples/sycl/README.md index c5d982ff3..3247048ab 100644 --- a/examples/sycl/README.md +++ b/examples/sycl/README.md @@ -6,11 +6,11 @@ This example program provide the tools for llama.cpp for SYCL on Intel GPU. |Tool Name| Function|Status| |-|-|-| -|ls-sycl-device| List all SYCL devices with ID, compute capability, max work group size, ect.|Support| +|ls-sycl-device| List all SYCL devices with ID, compute capability, max work group size, etc.|Support| ### ls-sycl-device -List all SYCL devices with ID, compute capability, max work group size, ect. +List all SYCL devices with ID, compute capability, max work group size, etc. 1. Build the llama.cpp for SYCL for all targets. diff --git a/examples/whisper.wasm/README.md b/examples/whisper.wasm/README.md index da629c5f3..25ebc903c 100644 --- a/examples/whisper.wasm/README.md +++ b/examples/whisper.wasm/README.md @@ -64,4 +64,4 @@ cp bin/libmain.worker.js /path/to/html/ > 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no > longer generated and the worker is embedded in the main JS file. So the worker -> file will not be geneated for versions later than `3.1.58`. +> file will not be generated for versions later than `3.1.58`.