rokucommunity / rokucommunity/brighterscript
Clarify "view transpiled code" for interface docs
Open
Beginner friendly
Nobody has claimed this yet.
help wanted
- Dominant language
- TypeScript
- Stars
- 208
- Forks
- 68
- Avg merge
- 8h 39m
- Merged PRs (30d)
- 39
Description
https://github.com/rokucommunity/brighterscript/blob/master/docs/interfaces.md
The bottom 3 examples have empty transpiled code blocks (as to be expected). But that may be confusing for new readers. We should add a comment or explanation for why they're empty
Contributor guide
No contributing guide indexed for this repository
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
Open docs/interfaces.md and review the bottom three examples and their empty transpiled code blocks. Add a brief comment or explanation of why those blocks are empty, then verify that each example is clear to a new reader.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100