Skip to content

docs(src/math): Use describe() instead of @alt #5596

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.

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

Merged
merged 1 commit into from
Feb 20, 2022

Conversation

Zearin
Copy link
Contributor

@Zearin Zearin commented Feb 6, 2022

Addresses #5139. Attention @lm-n. ;-)

Changes:
Use describe() over @alt in inline docs within 📁 src/math/.

PR Checklist

@Zearin
Copy link
Contributor Author

Zearin commented Feb 19, 2022

@lm-n ping 😇

@lm-n lm-n merged commit a852280 into processing:main Feb 20, 2022
@@ -303,13 +298,12 @@ p5.prototype.radians = angle => angle * constants.DEG_TO_RAD;
* angleMode(RADIANS); // Change the mode to RADIANS
* rotate(a); // variable a stays the same
* rect(-40, -5, 20, 10); // Smaller rectangle is rotating in radians
* describe(`40×10 rect in center rotates with mouse moves.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Zearin could you make a new PR correcting this to 40 by 10. Screen readers would otherwise read this as 40 ex 10

Copy link
Member

@lm-n lm-n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Zearin could you change descriptions that say numberxnumber to number by number. Screen readers would otherwise read those as number ex number

@@ -303,13 +298,12 @@ p5.prototype.radians = angle => angle * constants.DEG_TO_RAD;
* angleMode(RADIANS); // Change the mode to RADIANS
* rotate(a); // variable a stays the same
* rect(-40, -5, 20, 10); // Smaller rectangle is rotating in radians
* describe(`40×10 rect in center rotates with mouse moves.
* 20×10 rect moves faster.`);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here also 20 by 10 otherwise it is read 20 ex 10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants