metasploit-framework

https://github.com/rapid7/metasploit-framework

Ruby

Metasploit Framework

Msf::OptBase#initialize

Initializes a named option with the supplied attribute array.
The array is composed of three values.

attrs[0] = required (boolean type)
attrs[1] = description (string)
attrs[2] = default value
attrs[3] = possible enum values
attrs[4] = Regex to validate the option

Attrs can also be specified explicitly via named parameters, or attrs can
also be a string as standin for the required description field.

Source | Google | Stack overflow

Edit

git clone [email protected]:rapid7/metasploit-framework.git

cd metasploit-framework

open lib/msf/core/opt_base.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Msf--OptBase-initialize-for-pr

# Commit to git

git add lib/msf/core/opt_base.rbgit commit -m "better docs for Msf::OptBase#initialize"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Msf--OptBase-initialize-for-pr

hub pull-request

# Celebrate!