Use shorter syntax in README example #167
Open
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.
Just from a quick glance at the README, it's not obvious that there's a shorter single-line syntax that could be used instead of the multiple
# @rbs name: Type
lines.When I showed this repo to several coworkers, they all got the mistaken impression that the signitures have to be multiple lines like JavaDoc or JSDoc.
To fix this, I suggest we highlight the short syntax in the first and main example.
Optionally, we could add another method as an example of the longer syntax, showing how it can be useful for methods with many parameters and/or long types, like this one:
rbs-inline/sig/generated/rbs/inline/ast/members.rbs
Lines 109 to 113 in 5b4885b