How to use type aliases?
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 256
- Avg merge
- 6d 17h
- Merged PRs (30d)
- 37
Description
In my code, I have a function that returns RBS::Parser.parse_type(...). So do I declare the return value to be RBS::Types::t? But that type is not listed in rbs -r rbs list. So I don't know if it's acceptable (public?) or not.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the RBS::Parser.parse_type return value and the RBS::Types::t reference mentioned in the issue, then compare them with the entries shown by rbs -r rbs list. Determine how type aliases are intended to be declared and whether this type is public; done means the supported usage and visibility are documented clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100