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.

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

Parameter list of fill() and stroke() lack alpha parameter description #657

Open
FrauBoes opened this issue Dec 6, 2024 · 4 comments
Open
Labels
Bug Something isn't working Good First Issue Good for newcomers Help Wanted Extra attention is needed

Comments

@FrauBoes
Copy link

FrauBoes commented Dec 6, 2024

Most appropriate sections of the p5.js website?

Reference

What is your operating system?

Mac OS

Web browser and version

131.0.6778.87 (Official Build) (x86_64)

Actual Behavior

The parameter list is missing the description of the alpha parameter.

Screenshot 2024-12-06 at 14 49 05

The description is present in the source code:

https://github.com/processing/p5.js/blob/1ed240c3b4f9f286010a47d456d216f639f741f5/src/color/setting.js#L1003

Expected Behavior

The description of the alpha parameter should be displayed on the website.

Steps to reproduce

Go to https://p5js.org/reference/p5/fill/ and see the parameter list.

Would you like to work on the issue?

Yes

@FrauBoes FrauBoes added the Bug Something isn't working label Dec 6, 2024
@ksen0
Copy link
Contributor

ksen0 commented Dec 6, 2024

Hello @FrauBoes ,

Would you like to work on this? If so you, can prepare a pull request

Description can be from from source code ("optional alpha value, controls transparency (0 - transparent, 255 - opaque).") - or from other pages with an alpha parameter that has a description (Number: alpha value relative to current color range (default is 0-255).)

Besides fill there may be other pages; I see https://p5js.org/reference/p5/stroke/ also has the same issue, though I can't think of others at the moment.

@ksen0 ksen0 added Help Wanted Extra attention is needed Good First Issue Good for newcomers labels Dec 10, 2024
@FrauBoes
Copy link
Author

Hi @ksen0,

Happy to fix this! I created a draft PR here: processing/p5.js#7420

Draft PR because I see that the missing description of fill() was fixed recently:

processing/p5.js#7362

However, when checking the live reference page, the alpha parameter still doesn't have a description:

https://p5js.org/reference/p5/fill/

Is the fix not deployed yet?

Either way, my PR adds the description to stroke() and makes another tiny correction (removing the word 'optional' to avoid duplication)

@FrauBoes FrauBoes changed the title Parameter list of p5js.org/reference/p5/fill/ is missing alpha parameter description Parameter list of fill() and stroke() lack alpha parameter description Dec 11, 2024
@davepagurek
Copy link
Collaborator

Is the fix not deployed yet?

Currently the docs only update when we release a new version of p5. We've been trying to do minor version releases more often so that the docs are more up to date, but it does mean that the docs won't immediately update when a PR into the p5 repo is merged.

@FrauBoes
Copy link
Author

Thanks for the info! I started the review of the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Good First Issue Good for newcomers Help Wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants