document box color for showCollisionBoxes
Open
Nobody has claimed this yet.
docs :scroll:
- Dominant language
- TypeScript
- Stars
- 12.4k
- Forks
- 2.4k
- PR merge metrics
- No merged PRs in 30d
Description
I think it would be helpful to document for showCollisionBoxes what red vs blue boxes mean, and what it means when a symbol text box is rendered as blue but the text is not shown, even when there is no obvious collision..
- Gets and sets a Boolean indicating whether the map will render boxes
- around all symbols in the data source, revealing which symbols
- were rendered or which were hidden due to collisions.
- This information is useful for debugging.
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
No file or test is named. Start by locating the showCollisionBoxes API documentation and its implementation, then verify what red, blue, and blue-but-hidden boxes represent; done when those cases are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100