Support single overload #168
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This functionality is mainly required for YARD docs for C/C++ extensions.
Now the information in @overload tag does not replace MethodObject object, it is merged into MethodObject object.
|
Thanks! I've never seen this before, interesting to know about :) |
|
This change is included in release 5.1.0 and also 6.0.0, so you can pick which to use depending on whether 6.0's breaking change affects you (support for RBS 3.0) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Outline
This PR adds support for a single "overload" tag. This PR is required to handle YARD documents for C/C++ extension.
Background
The "overload" tag in YARD is used for the following two purposes:
The YARD system can not retrieve signatures of methods written by C/C++, therefore overload tag is usually used to describe such method signatures.
Description
This PR treats such an overload tag by replacing the method signature with the content of the first overload tag.
The information contained in the overload tag is also merged into the method object.
Limitation
The second and subsequent overload tags are ignored.