Tonejs / Tonejs/tonejs.github.io
"wrong" info in docs -> FM synth, harmonicity :)
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 96
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Description
Hi Tone people!
Love your work. I'm sitting and have just started learning, and would like to inform you, that I believe I found a small typo in the doc.
https://tonejs.github.io/docs/14.7.77/FMSynth#harmonicity
It's written as if one creates an AMSynth where I guess it would make more sense to create an FMSynth, if people where copy/pasting the example :)
Have a nice evening! :)
Best, Lasse
Contributor guide
No contributing guide indexed for this repository
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
Open the Tone.js documentation page for FMSynth#harmonicity and inspect the harmonicity example. Confirm whether the example refers to AMSynth instead of FMSynth, then correct the documented example so it matches the section. Done means the example is consistent with the FMSynth harmonicity documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100