processing / processing/p5.js-website

Documentation missing for p5.sound's noteToFreq()

Open
#672 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request
Dominant language
MDX
Stars
96
Forks
322
Avg merge
5d 22h
Merged PRs (30d)
8

Description

Increasing Access

Note names (i.e.: C, F#, Ab) are often more recognisable to beginner musicians than MIDI note numbers or frequencies. the noteToFreq() function provides an easy way to convert familiar note names into standard values for synthesis... but there is no mention of this function in the docs.

Most appropriate sub-area of p5.js?

Reference

Feature request details

Reference documentation should be provided for this function.

https://github.com/processing/p5.js/blob/1ed240c3b4f9f286010a47d456d216f639f741f5/lib/addons/p5.sound.js#L892-L924

I would like to be assigned to work on this if its required, please (I teach electronic music).

Contributor guide

No contributing guide indexed for this repository

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 p5.sound.js source at lines 892-924 to understand noteToFreq(), then inspect the p5.js website's Reference documentation patterns. Add a reference entry for the function and verify that its note-name conversion behavior is documented.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.