Skip to content

directionalLight reference error (typo) #7743

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

Open
quarks opened this issue Apr 16, 2025 · 4 comments
Open

directionalLight reference error (typo) #7743

quarks opened this issue Apr 16, 2025 · 4 comments

Comments

@quarks
Copy link

quarks commented Apr 16, 2025

In the website reference for diectionalLight there are a couple of typos -

Para 5:
'direction sets the light’s direction using a p5.Geometry object'
should be
'direction sets the light’s direction using a p5.Vector object'

Para 7:
'direction, sets the light’s direction using a p5.Color object.'
should be
'direction, sets the light’s direction using a p5.Vector object.'

@ksen0
Copy link
Member

ksen0 commented Apr 16, 2025

Thanks for catching this! The documentation is actually built from the documentation in the source code, so I'll transfer this to p5.js repository. Additionally, it is best to make 2 parallel PRs for the two different versions (and I see it applies in both cases), otherwise it may take a while to propagate the change in both the main and beta reference sites:

Would you like to work on this?

@ksen0 ksen0 transferred this issue from processing/p5.js-website Apr 16, 2025
@ksen0 ksen0 moved this to To Do in p5.js Documentation Apr 18, 2025
@LalitNarayanYadav
Copy link
Contributor

Hi! @ksen0 I'd like to work on this issue.

@Mamatha1718
Copy link

Hi @quarks , @ksen0 ,
I created a pull request of this issue #7756 will you please review it.
Thank you in Advance!

@LalitNarayanYadav
Copy link
Contributor

👋 Request for Review

Hi @ksen0, @quarks 👋

I’ve created two separate pull requests to address the documentation typos mentioned in issue #7743:

  • #7777 – Fix for the main (1.11) branch
  • #7778 – Fix for the dev-2.0 branch

✅ Replaced incorrect references to p5.Geometry and p5.Color with p5.Vector in the directionalLight() documentation comments.

Kindly review the PRs when you get a chance. Happy to make any adjustments if needed.
Thank you!

limzykenneth added a commit that referenced this issue May 2, 2025
"Fix typo in directionalLight reference (main branch)" - #7743
davepagurek added a commit that referenced this issue May 8, 2025
Fix typo in directionalLight reference (dev-2.0 branch) #7743
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Ready for Work
Development

Successfully merging a pull request may close this issue.

4 participants