See https://sorbet.org/docs/sigs for information on method signatures.
Given this example:
# This is the mymethod1 comment
sig do
params(
# This is an integer
anint: Integer,
# This is a string
astring: String
).void
end
def self.mymethod1(anint, astring)
# ...
end
# This is the mymethod2 comment
def self.mymethod2(anint, astring)
# ...
end
# This is the mymethod3 comment
#
# :args: anint, astring
#
def self.mymethod3(anint, astring)
# ...
endthe following markdown is generated:
### mymethod1(anint, astring) [](#method-c-mymethod1)
### mymethod2(anint, astring) [](#method-c-mymethod2)
This is the mymethod2 comment
### mymethod3(anint, astring) [](#method-c-mymethod3)
This is the mymethod3 comment
mymethod1 uses Sorbet's sig and you can see it has no generated documentation at all.
mymethod2 and mymethod3 do not use sig and the method comment is included in the generated markdown.
I attempted to use :args: with mymethod3 and it did not change anything, so I filed #37 separately.
mymethod4
See https://sorbet.org/docs/sigs for information on method signatures.
Given this example:
the following markdown is generated:
mymethod1uses Sorbet'ssigand you can see it has no generated documentation at all.mymethod2andmymethod3do not usesigand the method comment is included in the generated markdown.I attempted to use
:args:withmymethod3and it did not change anything, so I filed #37 separately.mymethod4