observablehq / observablehq/plot
`Mark` type definitions are missing public (?) API
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 5.4k
- Forks
- 244
- PR merge metrics
- No merged PRs in 30d
Description
According to https://observablehq.com/@observablehq/read-channels-initialized-by-a-plot-mark we can access the plotted data as transformed by Plot. (I hope this API hasn’t become internal since.)
The initialize function, however, is missing from the type definitions:
I also couldn’t find this in the documentation.
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 src/mark.d.ts around lines 483–492 and compare the available Mark type definitions with the initialize API described in the linked Observable example. Confirm whether initialize is public, then update the type definitions and documentation so the API is represented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100