From 8779514d3f91e6413d1131b45572e1d5c1e279d3 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Fri, 4 Jun 2021 02:43:38 +0200 Subject: [PATCH] Readme --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 5328727..871f377 100644 --- a/readme.md +++ b/readme.md @@ -240,7 +240,7 @@ args.RegisterConstraints({pc}); What doesn't work is inserting multiple constraints for one key. It will just discard the oldest one. But that's okay because one can describe all possible constraints for a single key in **one** struct. ## Automatic parameter documentation -Hazelnupp does create an automatic parameter documentation accessible via `--help`. +Hazelnupp does automatically create a parameter documentation, accessible via `--help`. If you want to use `--help` yourself, just turn it off. ```cpp Hazelnupp args; @@ -281,7 +281,7 @@ Hazelnupp args; args.SetBriefDescription("This is the testing application for Hazelnupp."); ``` -If you want to display this information somewhere else, you can always access it via `args.GenerateDocumentation()`. +If you want to display this information somewhere else, you can always access it as a string via `args.GenerateDocumentation()`. ## More examples? Check out the unit tests! They may help you out!