Exclude string.rb from consideration by YARD. #1853
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 is necessary because otherwise YARD will assume all references to "String" mean Faker::String. The long-term solution for this is probably to deprecate Faker::String and move the Faker::String.random method into Faker::Types.
Zeragamba
approved these changes
May 18, 2020
|
I think it's a good workaround in the meantime as well. |
|
merged :) |
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.
This is a bit of a dumb hack. Without this, YARD will assume all references to "String" (so pretty much every return type in the entire codebase) mean
Faker::String, which is incorrect, and also messes up the auto-generated Sorbet types and the VS Code IntelliSense provided by solargraph.The long-term solution for this is probably to deprecate
Faker::Stringand move theFaker::String.randommethod intoFaker::Types.The downside to this solution is that the
Faker::Stringclass is excluded from the YARD docs, but unfortunately I can't think of a better option (I generally consider replacing every instance ofStringin the YARD docs with::Stringto not be a reasonable solution).@vbrazo @Zeragamba thoughts?