Improve doc

sportradar · Oct 22, 2024 · 27821fd · 27821fd
1 parent 696ab3a
commit 27821fd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/cli_options/CHANGELOG.md b/cli_options/CHANGELOG.md
@@ -35,7 +35,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   CliOptions.parse(["--verbose", "--silent"], schema, post_validate: post_validate)
   >>>
 
-  # if only one of the two is passed the validation returns :ok
+  # if only one of the two is passed the validation succeeds
   CliOptions.parse(["--verbose"], schema, post_validate: post_validate)
   >>>
   ```

diff --git a/cli_options/lib/cli_options.ex b/cli_options/lib/cli_options.ex
@@ -490,7 +490,7 @@ defmodule CliOptions do
   CliOptions.parse(["--verbose", "--silent"], schema, post_validate: post_validate)
   >>>
 
-  # if only one of the two is passed the validation returns :ok
+  # if only one of the two is passed the validation succeeds
   CliOptions.parse(["--verbose"], schema, post_validate: post_validate)
   >>>
   ```