processing / processing/p5.js

touches docs: bad phrasing could lead to confusion

Open
#6,032 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Discussion
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

Description

Topic

On the touches reference page it says:

"The touches[] array is not supported on Safari and IE on touch-based desktops (laptops)."

I think people (including myself haha!) could be confused by this sentence and think that touches is not supported on Safari in general, but it is supported on iOS. I suggest changing the sentence to this:

"The touches[] array is not supported on touch-based desktops and laptops in Safari and Internet Explorer."

But this info is pretty irrelevant for two reasons. One is that macOS has no support for touch and there are no Macs with touch screens, any Mac user already knows that so pointing it out is redundant. Also IE was replaced by Edge a few years ago. It's a given that it lacks features. I doubt any student or teacher would be randomly using IE on their Microsoft Surface or other touch-based desktop/laptop anyway so I'd just remove the whole sentence.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the touches reference page and review the quoted browser-support sentence in context. Decide whether the sentence should be clarified or removed, then update the page so it does not imply that touches is unsupported in Safari generally; done means the outdated or confusing wording is no longer present.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.