Ambiguities in event documentation
@ansis is already working on this.
Since Jul 9, 2021.
- Dominant language
- TypeScript
- Stars
- 12.4k
- Forks
- 2.4k
- PR merge metrics
- No merged PRs in 30d
Description
There are a few events that use the ambiguous wording "when X occurs", rather than a more precise "before X occurs" or "immediately after X occurs".
For instance, does StyleData fire after a style JSON has been fetched (but before it is applied), or later than that? (I was trying to find out whether this was a good hook to manipulate a style after it's been fetched but before it is rendered).
Also, I don't know if I'm looking in the wrong place, but I can't see anywhere where the on() function is documented. In particular, I was trying to find out whether event handlers like moveEnd are removed after they fire once - and if not, how one removes them?
Lastly, the ordering of the events in the documentation is a bit weird. moveend, mouseup, mousemove, touchstart, move, movestart...
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.
Assessment
This issue has not been assessed yet.