Docs: Prevent virtual types reaching docs generator #6246
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
|
Thanks @bcardiff! Just to be clear, do you want me to pull this branch done and try to use it to generate docs for Lucky? |
|
I did and the docs were generated. So far the output seems right, but you might want to double check it. So, yes please if you want :-) |
|
Awesome! Thanks so much for the fix. I'm excited to give it a try |
sdogruyol
approved these changes
Jun 22, 2018
RX14
approved these changes
Jun 25, 2018
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.
Fixes #6201
I was unable to reduce the code for a short repro. But somehow the
Lucky::Routeablemanaged to produce some virtual types that were not handled in the docs generator.Virtual types does not make sense in the doc generator since from the user perspective they are always substitutable by a subclass. That is what virtual types represent inside the compiler, while a type is an exact reference. This serves mainly during the codegen.
@paulcsmith, would you mind checking the the output is the expected one? The method that complained was
Lucky::Route#actionthat was returning a virtual type ofLucky::Action.class