Implement @param tag handling #21
Open
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
By parsing the route using Mustermann, we can find the named parameters; these can then be passed to the RouteObject so that YARD doesn't complain. It is important to set the docstring *after* the parameters are set, otherwise the unknown parameter warning will still occur once. In RouteObject, we need to override the parameters attribute to prevent parameters from being shown in the signature of the route 'method', e.g. `#GET /:id(id)`, which looks strange.
|
Because Mustermann requires Ruby > 2.2.0, this will not work with earlier versions. |
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.
By parsing the route using Mustermann, we can find the named parameters; these can then be passed to the RouteObject so that YARD doesn't complain. It is important to set the docstring after the parameters are set, otherwise the unknown parameter warning will still occur once.
In RouteObject, we need to override the parameters attribute to prevent parameters from being shown in the signature of the route 'method', e.g.
#GET /:id(id), which looks strange.Fixes #6.