From e086382b11b0fd3720fa03857fcb761934da350e Mon Sep 17 00:00:00 2001 From: Tib3rius <48113936+Tib3rius@users.noreply.github.com> Date: Mon, 30 Aug 2021 02:01:54 -0400 Subject: [PATCH] Updated API Documentation (markdown) --- API-Documentation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/API-Documentation.md b/API-Documentation.md index 65e5fe3..704eb1c 100644 --- a/API-Documentation.md +++ b/API-Documentation.md @@ -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. \ No newline at end of file