[p5.js 2.0 Bug Report]: width/height/options overloads inconsistent/incorrect for typography methods
Nobody has claimed this yet.
- 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
2.0.2
Web browser and version
N/A
Operating system
N/A
Steps to reproduce this
textToModel has these overloads:
textToModel(str, x, y, width, height, [options], [options.extrude], [options.sampleFactor])
textToContours has these overloads:
textToContours(str, x, y, [options])
textToPoints has these:
textToPoints(str, x, y, [options])
A few issues to fix:
-
All of these optionally support width and height. The overloads should maybe be:
something(str, x, y, [options]) something(str, x, y, width, height, [options]) -
All should have the same base options. These include
sampleFactorandsimplifyThreshold(see the 1.x docs for descriptions of these.)textToModeladditionally hasextrude.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the textToModel, textToContours, and textToPoints entry points and compare their current overloads with the linked 1.x textToPoints documentation. Align the optional width and height signatures and shared options, retaining extrude for textToModel; done means the three typography methods describe consistent supported arguments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend, web-dev
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100