Add docs to teach RBS method syntax #694
Merged
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 put this doc together to teach my team how to write method signatures. It's assumes the audience knows nothing about RBS, but is familiar with the standard library, and uses that as a starting point for teaching RBS syntax/grammar. When I was learning RBS, I mostly learned through trial-and-error, and I hope that this guide can help people become proficient in signature writing faster.