Clarify controller example #405
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
I think the intention was to interpolate the inspected controller name but the code block shows the original source which makes it, IMO, unnecessarily confusing as an example, since if you copy this code it fails to compile, but if you omit that line it silently fails to load the docs, which was frustrating as a beginner.
|
👍 Agreed, unnecessarily clever example there :) |
lucacorti
pushed a commit
to lucacorti/open_api_spex
that referenced
this pull request
Feb 13, 2022
Replace dynamic module name interpolation with module name constant in example docs
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.
I think the intention was to interpolate the inspected controller name but the code block shows the original source which makes it, IMO, unnecessarily confusing as an example, since if you copy this code it fails to compile, but if you omit that line it silently fails to load the docs, which was frustrating as a beginner.