-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
docs(src/color/): Use describe('…')
over @alt
#5577
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
Conversation
**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).
Weird…I’ve not encountered a change to the docs that had any impact on the tests before! There are 8 failing tests here, and all appear to be the same error. Here is the first error for convenience:
Unfortunately, I have no idea how to interpret this error message, or what to do about it. Can a maintainer or Processing member help point me in the right direction? |
You might have already done so but I would prefer if you can get in touch with @lm-n before starting work on this issue, simply in case there are duplicate work already done. The tests includes running all the example sketches in the inline reference which is where the error likely comes from. @lm-n would know more about this issue than I do which is why I would advise getting in contact first. |
@limzykenneth : According to @lm-n’s GitHub Profile page, he hasn’t been active in several months. Assuming it’s not possible to coordinate with @lm-n, how do you suggest I should proceed? |
@Zearin I've reviewed your changes and will look at the errors in a bit. |
I stand corrected. 😄 Thank you for the guidance, @lm-n ! |
Link to relevant feedback: processing#5577 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Zearin describe()
must be inside the setup() or draw() that's where the error is coming from!
Should fix the failing tests 🤞
@Zearin & @limzykenneth I'm merging this PR! Thanks @Zearin, feel free to help transition more reference example to use describe()! |
Addresses #5139, #5140, and #5427.
Changes:
Summary:
@alt
I found in 📁src/color
.@alt
was not linted for line length whiledescribe(…)
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:
describe()
function in p5 sketches? #5427, the idea requiring this for the inline docs got positive support from several members (including @lmccart, @outofambit, and @catarak).PR Checklist
npm run lint
passes