[p5.js 2.0]: reference errors: textToContours() and textToModel()

[shiffman]

Most appropriate sub-area of p5.js?

• Accessibility
• Color
• Core/Environment/Rendering
• Data
• DOM
• Events
• Image
• IO
• Math
• Typography
• Utilities
• WebGL
• Build process
• Unit testing
• Internationalization
• Friendly errors
• Other (specify if possible)

p5.js version

No response

Web browser and version

No response

Operating system

No response

Steps to reproduce this

I'm finally finishing up a video that I recorded months ago about some of the new typography features in p5.js 2.0. I found two errors on the reference for p5.js 2.0.

textToContours() page: https://beta.p5js.org/reference/p5.font/texttocontours/

Here, the method is referred to as textToPoints() where it should read:

The fourth parameter, options, is also optional. font.textToContours() expects an object with the following properties:

textToModel() page: https://beta.p5js.org/reference/p5.font/texttomodel/

The [options] property is specified under "Syntax" but the options extrude and sampleFactor are not listed on the page anywhere that I can see (though they are used in the examples).

[Jeconiah20]

Hi ! I'm new to open source contribution can I work on this issue?

[ksen0]

Thanks @shiffman !

@Jeconiah20 Welcome! Are you also new to development/p5?

Feel free to make a PR in the next couple of days, but please ask for help, this might sound like a simpler task than it is. For updating the reference, the guide it here: https://github.com/processing/p5.js/blob/main/contributor_docs/contributing_to_the_p5js_reference.md

What's important is that y0u need both p5.js-website repo to test out your changes, and the p5.js repo to update the docs. Be sure to work with the correct branch: on the website, it's 2.0. In this repository, it's dev-2.0. The PR should start with the correct branch and target this branch.

[shiffman]

Just adding another reference error I found

https://beta.p5js.org/reference/p5.font/texttocontours/

Each point object in a contour array has three properties that describe the point's location and orientation, called its path angle. For example, { x: 10, y: 20, alpha: 450 }.

According to the discussion in #8177 the alpha property will be called angle.

[shiffman]

Ah, and another note about the textToContours() reference! It currently reads:

sampleFactor is the ratio of the text's path length to the number of samples. It defaults to 0.1. Higher values produce more points along the path and are more precise.

The first sentence isn't consistent with the second I don't think? If sampleFactor were the ratio of path length to number of samples (sampleFactor = pathLength / samples), then lower values would produce more points, not fewer.

From experimenting with the function, I think this would be more accurate?

sampleFactor controls how densely points are sampled along the text’s path. The approximate number of sampled points is proportional to the path length multiplied by sampleFactor (points ≈ pathLength × sampleFactor).

I believe the current wording may come from how OpenType.js describes its sampling internally?

Here's a sketch I made that I believe matches how it works:
https://editor.p5js.org/codingtrain/sketches/c23YgfIhC

Tagging @davepagurek for feedback on this, thank you!!

[davepagurek]

Thanks @shiffman! The sentence you wrote is indeed how it works, and probably the old phrasing did come from the 1.x implementation that worked more like OpenType. I'm happy to go with your phrasing!

[Kathrina-dev]

Hi! I’ve recently started contributing to p5.js and just opened my first PR fixing a TypeScript typing issue. I’d love to help with this reference fix as well.

I noticed @Jeconiah20 asked about working on it last week. If it’s still available (or if there are additional documentation fixes needed here), I’d be happy to take it and open a PR targeting the dev-2.0 branch as suggested.

Thanks!

[Kathrina-dev]

Note: the commit that briefly referenced this issue was added by mistake while I was testing the PR from the previous contributor locally. It wasn’t intended to address this issue, and I removed it from my branch afterwards.