Updating all the broken refrence examples. #7739
Conversation
|
Hi @perminder-17 , thanks for working on this! A couple more things - some of these may not be in documentation scope, so please comment here if you end up working on this and find these can't be fixed in documentation itself:
|
|
Hi kit,
Yes, sure. I have been looking for couple of things which can't be fixed through just changing the docs. Some additional works may be involved. I'll write it up here and open up an issue for that as well.
Yes, I think there could be more, I'll have a look.
Yep, I just noticed that now. Really thanks for catching this. I'll have a look and will update this PR if its not pointing to a bigger issue. Thanks for the updates :) |
Hi @ksen0 , Actually we get the documentation of the sound reference by cloning this repo : https://github.com/processing/p5.sound.js into the website and then it builds the jsDocs for this. And, the older sound library of p5 has been closed/deprecated. https://github.com/processing/p5.js-sound.git But now also, we are using the older build in our p5.js addons library in actual dev-2.0 branch. https://github.com/processing/p5.js/blob/dev-2.0/lib/addons/p5.sound.js One solution might be is, removing the older library from lib/addons and updating the new version of p5.js sound new sound library and include all the functions which were present on the older sound library and not present on the new one's. This will update the website with the docs. . Also, if we have any other approach for showing up the docs which currently uses the older-version lib/addons of sound library, I am happy to implement :")
For context, these are the docs which aren't shown when we build dev-2.0 branch, and these actually comes from the older version of sound library. |
|
Also tagging @davepagurek if this approach doesn't makes sense and needs to update the build of older-version of sound library? |
|
Hi @perminder-17 ! Just a quick note about the intent with sound: the 1.x reference on p5js.org should contain only the old sound library; and the 2.0 reference on beta.p5js.org should contain only the new one. Here's where that split was introduced: processing/p5.js-website#737 so things like |
| * <a href="#/p5/draw">draw()</a> begins looping. If the | ||
| * <a href="#/p5/preload">preload()</a> is declared, then `setup()` will | ||
| * run immediately after <a href="#/p5/preload">preload()</a> finishes | ||
| * <a href="#/p5/draw">draw()</a> begins looping. When `setup()` is declared async, |
There was a problem hiding this comment.
How about a slightly more precise description:
"When setup() uses the async keyword (like this: async function setup() instead of function setup())...."
| * <a href="#/p5/preload">preload()</a> is declared, then `setup()` will | ||
| * run immediately after <a href="#/p5/preload">preload()</a> finishes | ||
| * <a href="#/p5/draw">draw()</a> begins looping. When `setup()` is declared async, | ||
| * execution pauses at each `await` until the promise resolves, ensuring all assets |
There was a problem hiding this comment.
Similarly, providing a bit of explanation on promise:
"execution pauses at each await: for example, font = await loadFont(...) will wait for the font asset to load. This is because the loadFont(..) function returns a promise, and the await keyword means the program will wait for the promise to resolve."
Feel free to rephrase of course.
| @@ -596,7 +596,7 @@ function dom(p5, fn){ | |||
| * 'https://p5js.org/assets/img/asterisk-01.png', | |||
There was a problem hiding this comment.
Broken URL; maybe grab an image from another part of the reference that works? eg from https://beta.p5js.org/reference/p5/image/?
| * box(200, 200, 200); | ||
| * describe(`red horizontal line right, green vertical line bottom. | ||
| * black background.`); | ||
| * background(220); |
There was a problem hiding this comment.
Nice, thank you for the expanded example 👍
No description provided.