From c5ad36dd179c63517738cecaaf8474d8fd665a98 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Sun, 27 Mar 2022 13:44:43 -0400 Subject: README: Add a blurb about fancy errors/warnings --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index c68dd97..0ebac8f 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,28 @@ $ bfs -L haystack -name 'needle' │ $ find +
+bfs gives helpful errors and warnings. + +For example, `bfs` will detect and suggest corrections for typos: + +
+$ bfs -nam needle
+bfs: error: bfs -nam needle
+bfs: error:     ~~~~
+bfs: error: Unknown argument; did you mean -name?
+
+ +`bfs` also includes a powerful static analysis to identify likely mistakes: + +
+$ bfs -print -name 'needle'
+bfs: warning: bfs -print -name needle
+bfs: warning:            ~~~~~~~~~~~~
+bfs: warning: The result of this expression is ignored.
+
+
+
bfs adds some options that make common tasks easier. -- cgit v1.2.3