docs: improve instructions, fix typos

ttytm · Nov 3, 2023 · 0b77c45 · 0b77c45
1 parent f5e4d97
commit 0b77c45
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -36,33 +36,28 @@ purpose programming language with modern web technologies to design a graphical
 
 **Webview Module**
 
-- From source
+- Install the module
 
   ```sh
+  # From source
   v install --git https://github.com/ttytm/webview
+  # Or as vpm package
+  v install ttytm.webview
   ```
 
-- Or as vpm package
+- After the installation, build the webview C library to which the webview V module will bind.\
+  You can re-run the script at any point to rebuild the parent library with the latest upstream changes.
 
   ```sh
-  v install ttytm.webview
+  # For installations from source
+  ~/.vmodules/webview/build.vsh
+  # For installations as vpm module
+  ~/.vmodules/ttytm/webview/build.vsh
+  # PowerShell might require to prefix the script with `v`, e.g.:
+  v $HOME/.vmodules/webview/build.vsh
   ```
 
-## Usage
-
-After the installation, build the webview C library to which the webview V module will bind.\
-You can re-run the script at any point to rebuild the library with the latest upstream changes.
-
-```sh
-# For installations from source
-~/.vmodules/webview/build.vsh
-# For installations as vpm module
-~/.vmodules/ttytm/webview/build.vsh
-# PowerShell might require to prefix the script with `v`, e.g.:
-v $HOME/.vmodules/webview/build.vsh
-```
-
-### Usage Example
+## Usage Example
 
 > **Note**
 > When running and building on Windows, it is recommended to use `gcc` for compilation. E.g.:
@@ -134,8 +129,8 @@ file and on its [vdoc site](https://ttytm.github.io/webview/webview.html).
 
 ## Debugging
 
-Use the `webview_debug` flag to enable developer tools
-(allowing _right click_ <kbd>Inspect Element</kbd>) and `console.log` prints to the terminal. E.g.:
+Use the `webview_debug` flag to enable developer tools -
+enabling _right click_ <kbd>Inspect Element</kbd> and `console.log` prints to the terminal. E.g.:
 
 ```sh
 v -d webview_debug run .
@@ -145,9 +140,9 @@ Alternatively, control the debug mode explicitly for a window by creating it wit
 argument.
 
 ```v ignore
-webview.create() // enabled when the appliction was build with `-d webview_debug`
+webview.create() // enabled when the application was build with `-d webview_debug`
 webview.create(debug: true) // explicitly enabled for the window
-webview.create(debug: false) // explicitly disabled for the window
+webview.create(debug: false) // explicitly disabled for the window, even when built with `-d webview_debug`
 ```
 
 > **Note**

diff --git a/examples/v-js-interop-simple/main.v b/examples/v-js-interop-simple/main.v
@@ -27,7 +27,7 @@ const doc = '<!DOCTYPE html>
 		<script>
 			// Functions that are declared in JS can also be called from your V program.
 			function myJsFunction(myStrArg) {
-				// NOTE: Building in debug mode enables developer tools for a winodw.
+				// NOTE: Building in debug mode enables developer tools for a window.
 				// Also, console.log will additionally be printed to the terminal.
 				// This feature currently works with Linux and Windows.
 				console.log("Called myJsFunction:", myStrArg);

diff --git a/src/utils.v b/src/utils.v
@@ -8,7 +8,7 @@ enum ReturnKind {
 }
 
 // copy_char copies a C style string. The functions main use case is passing an `event_id &char`
-// to another thread. It helps to keep the event id available when executing `@retrun`
+// to another thread. It helps to keep the event id available when executing `@return`
 // from the spawned thread. Without copying the `event_id` might get obscured during garbage
 // collection and returning data to a calling JS function becomes error prone.
 fn copy_char(s &char) &char {