Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update inline documentation to use describe() instead of @alt | resolves #5139 #5140

Merged
merged 3 commits into from
Jan 30, 2022
Merged

Update inline documentation to use describe() instead of @alt | resolves #5139 #5140

merged 3 commits into from
Jan 30, 2022

Conversation

lm-n
Copy link
Member

@lm-n lm-n commented Mar 29, 2021 •
edited
Loading

Resolves #5139

Changes:

  • Update EN Contributor Docs
    Update documentation:
  • Color Creating and Reading examples
  • Color Setting examples
  • Shape 2D primitives examples
  • Shape Attributes examples
  • Shape Curves examples
  • Shape Vertex examples
  • Shape 3D primitives examples
  • Shape 3D models examples
  • Constants examples
  • Environment examples
  • Structure examples
  • DOM examples
  • Rendering examples
  • Foundation examples
  • Transform examples
  • Data Local Storage examples
  • Data Dictionary examples
  • Data Array Function examples
  • Data Conversion examples
  • Data String Functions examples
  • Events Acceleration examples
  • Events Keyboard examples
  • Events Mouse examples
  • Events Touch examples
  • Image examples
  • Image Loading and displaying pixels examples
  • IO (Input) examples
  • IO (Output) examples
  • IO Table examples
  • IO Time and Date examples
  • Math Calculation examples
  • Math Vector examples
  • Math Noise examples
  • Math Random examples
  • Math Trigonometry examples
  • Typography Attributes examples
  • Typography Loading and Display examples
  • Lights Camera - Interaction examples
  • Lights Camera - Lights examples
  • Lights Camera - Material examples
  • Lights Camera - Camera examples

Screenshots of the change:

PR Checklist

  • npm run lint passes
  • [Inline documentation] is included / updated
  • [Unit tests] are included / updated

@lm-n lm-n self-assigned this Mar 29, 2021
@lmccart lmccart mentioned this pull request Sep 29, 2021
Open
Zearin added a commit to Zearin/p5.js that referenced this pull request Jan 22, 2022
@Zearin
docs(src/color/): Use describe('…') over @alt
b371739 
**Summary:**
- This commit converts all the uses of `@alt` I found in 📁`src/color`.
- Since `@alt` was not linted for line length while `describe(…)` is, I had to add line breaks to the descriptions for the lint to pass (and allow the commit to go through).

**Related Issues & Pull Requests:**

- This is a small piece of the checklist described in Issue processing#5139 (by @lm-n).
- That issue, in turn, was begun in Pull Request processing#5140 (also by @lm-n).
- In Issue processing#5427, the idea requiring this for the inline docs got positive support from several members (including @lmccart, @outofambit, and @catarak).
@Zearin Zearin mentioned this pull request Jan 22, 2022
Merged
2 tasks
@lm-n lm-n merged commit 52a20ba into processing:main Jan 30, 2022
This was referenced Feb 3, 2022
Merged
Merged
Open
Open
This was referenced Mar 7, 2022
Open
Open
Merged
Open
Open
@renovate renovate bot mentioned this pull request Nov 20, 2022
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@lm-n lm-n

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use describe() to create accessible canvas descriptions in inline documentation
1 participant
@lm-n