processing / processing/p5.js

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

Open
#8,623 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Area:Typography p5.js 2.0+
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

Description

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).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the textToContours() and textToModel() reference pages linked in the issue, and compare their displayed method names, syntax, and option descriptions with the reported behavior. Update the textToContours() wording and document the textToModel() options extrude and sampleFactor, then review both pages to confirm the corrections are visible.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.