Updated API Documentation (markdown)

Tib3rius 2021-08-30 02:01:54 -04:00
parent 60af451dfa
commit e086382b11
1 changed files with 2 additions and 0 deletions

@ -157,3 +157,5 @@ The `tags` attribute is a list of tags that apply to the plugin. By default, the
### Methods
#### add_option(name, default=None, help=None)
The `add_option` method sets a command-line option for the plugin to use, where the value set to the option is stored. The `name` argument is used as part of the command-line option. For example, if a plugin called "HTTP" added an option with the `name` "threads", the command-line option would be --http.threads. The `default` argument is optional, but if set, will return if the user does not specify the command-line option. The `help` argument is also optional, but recommended to let users know what the option is to be used for.