observablehq / observablehq/plot
Plot’s warning feature ⚠️ needs documentation
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- HTML
- Stars
- 5.4k
- Forks
- 244
- PR merge metrics
- No merged PRs in 30d
Description
Warnings are only documented in https://github.com/observablehq/plot/blob/main/CHANGELOG.md#041.
ref. https://talk.observablehq.com/t/bar-chart-axis-is-inverted/6359/3
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 Warnings section in CHANGELOG.md under 0.4.1, then read the linked discussion about the inverted bar-chart axis for context. Document the warning behavior in the project’s user-facing documentation, with coverage beyond the changelog; done means users can find and understand the warnings.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100