SimpleAsyncComplementaryHelpers: updated docs

webwarrior-ws · webwarrior-ws · commit 82d9679fd602 · 2026-02-11T09:18:14.000+01:00
To include info about mode setting.
diff --git a/docs/content/how-tos/rules/FL0097.md b/docs/content/how-tos/rules/FL0097.md
@@ -47,3 +47,8 @@ For each function `FooAsync(): Task<'T>` create corresponding function `AsyncFoo
             }
         }
     }
+
+* *mode* - determines what functions are checked. Possible values: "OnlyPublicAPIsInLibraries", "AnyPublicAPIs", "AllAPIs".
+  * "OnlyPublicAPIsInLibraries" only runs in projects that are likely library projects.
+  * "AnyPublicAPIs" flags all public APIs.
+  * "AllAPIs" also flags (gives violations about) internal, private, and nested APIs.

Original file line number	Diff line number	Diff line change
@@ -47,3 +47,8 @@ For each function `FooAsync(): Task<'T>` create corresponding function `AsyncFoo
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`	`}`
	`50`	`+`
	`51`	`+* mode - determines what functions are checked. Possible values: "OnlyPublicAPIsInLibraries", "AnyPublicAPIs", "AllAPIs".`
	`52`	`+ * "OnlyPublicAPIsInLibraries" only runs in projects that are likely library projects.`
	`53`	`+ * "AnyPublicAPIs" flags all public APIs.`
	`54`	`+ * "AllAPIs" also flags (gives violations about) internal, private, and nested APIs.`