Fix TTY::Prompt#multi_select return type #208
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
Current return type is [String] but, actually the correct return type is [Array<String>].
|
@piotrmurach is this project still active and accepting PRs? |
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.
Describe the change
TTY::Prompt#multi_selectcurrent Yard documentation defines the return type as[String]when instead it is actually[Array<String>]I've also adding
/.idea/path to .gitignore if that is possible.Why are we doing this?
I favor to, to best of my abilities, to ensure libraries public methods Yard/RDoc are as more accurate as possible. This makes code documentation in the IDE to match the actual behavior/return type.
Benefits
IDE/language server correct method signature.
Drawbacks
Not aware of none.
Requirements
masterbranch?Documentation updated?