Update documentation for overloading methods #658
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From ruby/gem_rbs_collection#16:
I did not find the
...
triple dot syntax for overloading methods, e.g. when defining a method multiple times.I added the
DuplicatedMethodDefinitionError
to the docs/sigs.md, such that users that encounter that error have some pointers on what to do.I also added the
...
syntax to the_method-types_
in docs/syntax.md, but I'm not sure if that is 100% the correct place.In some places, the triple-dot (ellipsis) is used as a placeholder for "other may follow", which can be a bit confusing, and as such, I replaced it by
etc.
.However, at two places, I was not entirely sure if the
...
is a mere placeholder, or functions as the overloading operator:_method-name_
:_global-name_
:I'd appreciate it if someone could give some feedback, what function the
...
has at that place, I can then gladly add another commit to make it more clear.Regards, and thank you all for your work
Adrian