chore: make minor documentation related cleanups

ttytm · ttytm · commit 28a400596bb1 · 2023-09-15T14:41:01.000+02:00
diff --git a/examples/project-structure/README.md b/examples/project-structure/README.md
@@ -4,6 +4,8 @@ This example integrates the [`v-js-interop-app`](https://github.com/ttytm/webvie
 into a project structure that can be used as a starting guide for more complex Webview projects.
 
 ```
+├── assets/
+│   └── icon.ico
 ├── src/
 │   ├── api.v
 │   ├── main.v
diff --git a/examples/v-js-interop-simple/main.v b/examples/v-js-interop-simple/main.v
@@ -17,10 +17,10 @@ const doc = '<!DOCTYPE html>
 			function myJsFunction(myArg) {
 				console.log("Called myJsFunction:", myArg);
 			};
-			// Calls a V function that in turn calls the above JS function
+			// Calls a V function that in turn calls the above JS function.
 			window.interop();
 
-			// Calls a V function that returns a Value
+			// Calls a V function that returns a Value.
 			(async () => {
 				num = await window.double(2);
 				console.log(num);
@@ -36,7 +36,7 @@ fn interop(e &webview.Event) voidptr {
 	return webview.no_result
 }
 
-// Returns a value to JS
+// Returns a value to JS.
 fn double(e &webview.Event) int {
 	return e.int(0) * 2
 }
diff --git a/src/lib.v b/src/lib.v
@@ -60,7 +60,6 @@ pub const no_result = unsafe { nil }
 // Depending on the platform, a GtkWindow, NSWindow or HWND pointer can be passed here.
 // Returns null on failure. Creation can fail for various reasons such as when required runtime
 // dependencies are missing or when window creation fails.
-
 pub fn create(opts CreateOptions) &Webview {
 	return C.webview_create(int(opts.debug), opts.window)
 }
@@ -105,8 +104,8 @@ pub fn (w &Webview) get_window() voidptr {
 	return C.webview_get_window(w)
 }
 
-// set_icon updates the icon for the native window. It supports Windows HWND and Linux GTK windows
-// under X11 - Under Wayland, window application mapping is based on the desktop file entry name.
+// set_icon updates the icon of the native window. It supports Windows HWND windows and Linux GTK
+// windows under X11 - under Wayland, window application mapping is based on the desktop file entry name.
 // TODO: add macOS support
 pub fn (w &Webview) set_icon(icon_file_path string) ! {
 	$if windows {
diff --git a/tests/v_fn_call_test.v b/tests/v_fn_call_test.v
@@ -15,7 +15,7 @@ fn gen_html(test_name string, script string) string {
 }
 
 fn test_timeout() {
-	// We check if the V functions are called and windows closed successfully within 30 seconds.
+	// We check if the V functions are called and windows closed successfully within 60 seconds.
 	// Otherwise, windows can remain open and the test can run indefinitely.
 	spawn fn () {
 		time.sleep(60 * time.second)

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ fn gen_html(test_name string, script string) string {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`fn test_timeout() {`
`18`		`- // We check if the V functions are called and windows closed successfully within 30 seconds.`
	`18`	`+ // We check if the V functions are called and windows closed successfully within 60 seconds.`
`19`	`19`	`// Otherwise, windows can remain open and the test can run indefinitely.`
`20`	`20`	`spawn fn () {`
`21`	`21`	`time.sleep(60 * time.second)`