search

processing / p5.js-website

New p5.js website!
http://p5js.org
MIT License
18 stars 92 forks source link

p5.Camera not being treated as a class #563

Closed davepagurek closed 1 month ago

davepagurek commented 2 months ago

Most appropriate sections of the p5.js website?

Reference

What is your operating system?

Mac OS

Web browser and version

All

Actual Behavior

Currently, p5.Camera is showing up in the reference as a method.

Expected Behavior

Previously, it would show up as a class, and its methods would be available to browse.

Steps to reproduce

This happened in this commit https://github.com/processing/p5.js-website/commit/2438f3de63c1d654e066b970287b6c266295ddd4#diff-45545281b23895f7bbb1789126d4056142ce9a51dff2be85ee67889193f51edd after I rebuilt the docs from the v1.10.0 tag.

It looks like this may be because after the v1.10.0 release, a correction for this was added by @limzykenneth, and by locking the version number used in the reference to this specific tag, I've reverted to the older behaviour: https://github.com/processing/p5.js/commit/449e6dcb6fc1986090e31049575fca84f39f9ec1

Version locking is necessary so that new docs from unreleased features don't show up in the reference when we rebuild, and rebuilding is necessary to fix some bugs in the reference scripts. It sounds like in this case, we maybe need to replace v1.10.0 with 449e6dcb6fc1986090e31049575fca84f39f9ec1 (or maybe a new patch tag on the p5 repo to be more readable?), run npm run build:reference again, and then commit the results.

Would you like to work on the issue?

It's ok if someone else wants to take this on!

davepagurek commented 1 month ago

Version is updated so this is fixed; more frequent releases will help mitigate this issue.