From 319e918af6d1759ae89cadfae14372c20463c312 Mon Sep 17 00:00:00 2001 From: Philip Top Date: Sat, 16 Dec 2023 06:47:44 -0800 Subject: [PATCH] update docs on usage to indicate it is only available on main (#959) fix missing doc indicator on usage method --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 59b65ad9e..843eb106c 100644 --- a/README.md +++ b/README.md @@ -1001,10 +1001,10 @@ option_groups. These are: - `.prefix_command()`: Like `allow_extras`, but stop immediately on the first unrecognized item. It is ideal for allowing your app or subcommand to be a "prefix" to calling another app. -- `.usage(message)`: Replace text to appear at the start of the help string +- `.usage(message)`: 🚧 Replace text to appear at the start of the help string after description. -- `.usage(std::string())`: Set a callback to generate a string that will appear - at the start of the help string after description. +- `.usage(std::string())`: 🚧 Set a callback to generate a string that will + appear at the start of the help string after description. - `.footer(message)`: Set text to appear at the bottom of the help string. - `.footer(std::string())`: Set a callback to generate a string that will appear at the end of the help string.