class Toka::HelpPageRenderer
- Toka::HelpPageRenderer
- Reference
- Object
Overview
Renderer for a OptionDescriptor
, to be shown on a terminal.
By default, the user of your program can access this using the defualt
arguments "--help" and "-h". You can disable this if you want, see
Toka.mapping
.
Manual invocation
To manually render the help page, simply use #to_s
:
help = Toka::HelpPageRenderer.new(YourOptionClass)
puts help.to_s
Defined in:
toka/help_page_renderer.crConstant Summary
-
BASE_INDENT =
(OPTION_INDENT.size + 4) + 2
-
MAX_ALIGN =
20
-
OPTION_INDENT =
" "