Refactor using pointer events example

[erwanvivien]

Description

Tries to fix #34904

Motivation

Additional details

Related issues and pull requests

[github-actions]

This pull request has merge conflicts that must be resolved before it can be merged.

[github-actions]

Preview URLs

• /en-US/docs/Web/API/Pointer_events/Using_Pointer_Events
• /en-US/docs/Web/API/Pointer_events

(comment last updated: 2024-08-10 19:31:16)

[Josh-Cena]

@erwanvivien Hi, are you going to keep working on this?

[erwanvivien]

Hey @Josh-Cena happy to. I left comments here: #34904

Basically saying that I'm not sure how to interleave explanations and code

[Josh-Cena]

Are you unsure about editorial conventions or just what explanation to put down in general? Unfortunately I don't think the reviewers can help you much on writing out all the English without us actually doing it for you—but if you think that's necessary, you can definitely say so and one of the maintainers could take it over.

[erwanvivien]

just what explanation to put down in general

I think that would probably be that, in fact I think the previous explanations were kind of redundant with the code. That said I don't know who's the target of such page, is that experimented programmers?

one of the the maintainers could take it over

I'd appreciate that 🙏

[Josh-Cena]

That said I don't know who's the target of such page, is that experimented programmers?

That usually depends on the advancedness of the API itself. For example you can usually assume people reading about Proxy are experienced with JavaScript and people reading about WebGL is experienced with programming (but not necessarily JS). For this one, some level of familiarity with web APIs and JS is expected.

I think the previous explanations were kind of redundant with the code

I agree; which is not uncommon for old content because people come and go and put whatever they think is necessary here.

[Josh-Cena]

I looked at the code. It's big enough that we need to split them into chunks and explain each one. Remember that we are on a guide page anyway, so we need to explain how we arrive at each step. Code here is for demonstration, not for copy/pasting into your own application without knowing how it works.

[Josh-Cena]

I made some refactors and little fixes. Our code is no longer consistent with the dom-examples repo and we self-host this live example anyway, so I've removed the links to that. Thanks for the PR!

[erwanvivien]

@Josh-Cena thanks for pushing this to the finish line! I was in vacation, sorry for the late reply!