ci: add a report-wrong-examples-in-doc-comments job, that runs ./v doc -check-examples -f none vlib/ (#25554)

spytheman · web-flow · commit 999a6e3ef3dd · 2025-10-21T19:39:18.000+03:00
diff --git a/.github/workflows/docs_ci.yml b/.github/workflows/docs_ci.yml
@@ -71,3 +71,13 @@ jobs:
           vlib/rand/ vlib/compress/ vlib/clipboard/ \
           vlib/time/ \
           vlib/os
+
+  report-wrong-examples-in-doc-comments:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v5
+      - name: Build V
+        run: make
+      - name: Check examples in the doc comments for all vlib modules
+        run: ./v doc -check-examples -f none vlib/
diff --git a/vlib/os/os_nix.c.v b/vlib/os/os_nix.c.v
@@ -263,7 +263,7 @@ pub fn loginname() !string {
 
 // ls returns ![]string of the files and dirs in the given `path` ( os.ls uses C.readdir ). Symbolic links are returned to be files. For recursive list see os.walk functions.
 // See also: `os.walk`, `os.walk_ext`, `os.is_dir`, `os.is_file`
-// Example: https://github.com/vlang/v/blob/master/examples/readdir.v
+// Example:
 // ```
 //   entries := os.ls(os.home_dir()) or { [] }
 //   for entry in entries {
diff --git a/vlib/sokol/audio/audio.c.v b/vlib/sokol/audio/audio.c.v
@@ -205,7 +205,7 @@ pub fn fclamp(x f32, flo f32, fhi f32) f32 {
 // min - helper function to return the smaller of two numbers
 //
 // NOTE: math.min returns `f32` values, this returns `int` values
-// Example: smaller := audio.min(1, 5) // smaller == 1
+// Example: println(audio.min(1, 5))
 pub fn min(x int, y int) int {
 	if x < y {
 		return x
@@ -216,7 +216,7 @@ pub fn min(x int, y int) int {
 // max - helper function to return the larger of two numbers
 //
 // NOTE: math.max returns `f32` values, this returns `int` values
-// Example: larger := audio.max(1, 5) // larger == 5
+// Example: println(audio.max(1, 5))
 pub fn max(x int, y int) int {
 	if x < y {
 		return y
diff --git a/vlib/strconv/utilities.c.v b/vlib/strconv/utilities.c.v
@@ -37,7 +37,7 @@ pub fn f32_to_str_l(f f32) string {
 // f32_to_str_l_with_dot returns `f` as a `string` in decimal notation with a maximum of 8 digits after the dot.
 // If the decimal digits after the dot are zero, a '.0' is appended for clarity.
 //
-// Example: assert strconv.f32_to_str_l_with_dot(34.) == '34.0'
+// Example: assert strconv.f32_to_str_l_with_dot(34.2) == '34.2'
 @[manualfree]
 pub fn f32_to_str_l_with_dot(f f32) string {
 	s := f32_to_str(f, 8)
@@ -60,7 +60,7 @@ pub fn f64_to_str_l(f f64) string {
 // f64_to_str_l_with_dot returns `f` as a `string` in decimal notation with a maximum of 18 digits after the dot.
 // If the decimal digits after the dot are zero, a '.0' is appended for clarity.
 //
-// Example: assert strconv.f64_to_str_l_with_dot (34.) == '34.0'
+// Example: assert strconv.f64_to_str_l_with_dot(34.7) == '34.7'
 @[manualfree]
 pub fn f64_to_str_l_with_dot(f f64) string {
 	s := f64_to_str(f, 18)
diff --git a/vlib/strconv/vprintf.c.v b/vlib/strconv/vprintf.c.v
@@ -40,7 +40,7 @@ pub fn v_printf(str string, pt ...voidptr) {
 // Example:
 // ```v
 // x := 3.141516
-// assert strconv.v_sprintf('aaa %G', x) == 'aaa 3.141516'
+// assert unsafe{strconv.v_sprintf('aaa %G', x)} == 'aaa 3.141516'
 // ```
 @[direct_array_access; manualfree; unsafe]
 pub fn v_sprintf(str string, pt ...voidptr) string {
