Skip to content

Commit 49d27e0

Browse files
committed
remove doc comments for removed &block parameters
1 parent 81e50d2 commit 49d27e0

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

lib/functions_framework.rb

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ class << self
134134
# end
135135
#
136136
# @param name [String] The function name. Defaults to {DEFAULT_TARGET}.
137-
# @param block [Proc] The function code as a proc.
138137
# @return [self]
139138
#
140139
def http(name = DEFAULT_TARGET, &)
@@ -164,7 +163,6 @@ def http(name = DEFAULT_TARGET, &)
164163
# @param name [String] The function name. Defaults to {DEFAULT_TARGET}
165164
# @param request_class [#decode_json] An optional class which will be used to
166165
# decode the request if it implements a `decode_json` static method.
167-
# @param block [Proc] The function code as a proc @return [self]
168166
# @return [self]
169167
#
170168
def typed(name = DEFAULT_TARGET, request_class: nil, &)
@@ -187,7 +185,6 @@ def typed(name = DEFAULT_TARGET, request_class: nil, &)
187185
# end
188186
#
189187
# @param name [String] The function name. Defaults to {DEFAULT_TARGET}.
190-
# @param block [Proc] The function code as a proc.
191188
# @return [self]
192189
#
193190
def cloud_event(name = DEFAULT_TARGET, &)
@@ -196,7 +193,7 @@ def cloud_event(name = DEFAULT_TARGET, &)
196193
end
197194

198195
##
199-
# Define a server startup task. This is useful for initializing shared
196+
# Define a server startup task as a block. This is useful for initializing shared
200197
# resources that should be accessible across all function invocations in
201198
# this Ruby VM.
202199
#
@@ -208,7 +205,6 @@ def cloud_event(name = DEFAULT_TARGET, &)
208205
# Startup tasks are passed the {FunctionsFramework::Function} identifying
209206
# the function to execute, and have no return value.
210207
#
211-
# @param block [Proc] The startup task
212208
# @return [self]
213209
#
214210
def on_startup(&)

0 commit comments

Comments
 (0)