Skip to content

Commit 35ca8ad

Browse files
committed
Add doc changes from proofreading
1 parent fe4fdb1 commit 35ca8ad

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

plugins/request.rb

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ def parse_args(args, type = 'http')
9393
end
9494
end
9595

96-
# Parse the provided arguments for making HTTPS requests.
96+
# Parse the provided arguments for making HTTPS requests. The argument flags
97+
# are intended to be similar to the curl utility.
9798
#
9899
# @param args [Array<String>] The command line arguments to parse.
99100
# @param type [String] The protocol type that the request is for.
@@ -104,7 +105,8 @@ def parse_args_https(args = [], type = 'https')
104105
parse_args_http(args, type)
105106
end
106107

107-
# Parse the provided arguments for making HTTP requests.
108+
# Parse the provided arguments for making HTTP requests. The argument flags
109+
# are intended to be similar to the curl utility.
108110
#
109111
# @param args [Array<String>] The command line arguments to parse.
110112
# @param type [String] The protocol type that the request is for.
@@ -209,6 +211,7 @@ def parse_args_http(args = [], type = 'http')
209211
# @option opts [Hash] :headers A hash of additional headers to include in
210212
# the request.
211213
# @option opts [String] :method The HTTP method to use in the request.
214+
# @option opts [#write] :output_file A file to write the response data to.
212215
# @option opts [Boolean] :print_body Whether or not to print the body of the
213216
# response.
214217
# @option opts [Boolean] :print_headers Whether or not to print the headers
@@ -239,6 +242,7 @@ def handle_request_https(opts, opt_parser)
239242
# @option opts [Hash] :headers A hash of additional headers to include in
240243
# the request.
241244
# @option opts [String] :method The HTTP method to use in the request.
245+
# @option opts [#write] :output_file A file to write the response data to.
242246
# @option opts [Boolean] :print_body Whether or not to print the body of the
243247
# response.
244248
# @option opts [Boolean] :print_headers Whether or not to print the headers
@@ -314,7 +318,9 @@ def handle_request_http(opts, opt_parser)
314318
# Output lines based on the provided options. Data is either printed to the
315319
# console or written to a file. Trailing new lines are removed.
316320
#
317-
# @param opts [Array<Symbol>] The options as parsed from the command line.
321+
# @param opts [Hash] The options as parsed from parse_args.
322+
# @option opts [#write, nil] :output_file An optional file to write the
323+
# output to.
318324
# @param line [String] The string to output.
319325
# @return [nil]
320326
def output_line(opts, line)

0 commit comments

Comments
 (0)