Update rdoc.md

This commit is contained in:
Rico Sta. Cruz 2021-05-20 11:57:24 +10:00 committed by GitHub
parent 9762ba1f75
commit ee4ed02fa5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions

25
rdoc.md
View File

@ -21,6 +21,31 @@ layout: 2017/sheet
# @return [true] if so
```
### Hash parameters
```rb
# @param [Hash] opts the options to create a message with.
# @option opts [String] :subject The subject
# @option opts [String] :from ('nobody') From address
# @option opts [String] :to Recipient email
# @option opts [String] :body ('') The email's body
```
### Parameter types
```rb
# @param (see User#initialize)
# @param [OptionParser] opts the option parser object
# @param [Array<String>] args the arguments passed from input. This
# array will be modified.
# @param [Array<String, Symbol>] list the list of strings and symbols.
# @param [Hash<Symbol, String>] a hash with symbol keys and string values
#
# The options parsed out of the commandline.
# Default options are:
# :format => :dot
```
### Inline
```markdown