Add docs #766
Add docs #766
Conversation
Tone/component/analysis/DCMeter.ts
Outdated
| @@ -4,7 +4,9 @@ import { MeterBase, MeterBaseOptions } from "./MeterBase"; | |||
| export type DCMeterOptions = MeterBaseOptions; | |||
|
|
|||
| /** | |||
| * DCMeter gets the raw value of the input signal at the current time. | |||
| * DCMeter gets the raw value of the input signal's waveform amplitude | |||
| * at the current time and displays it as a value between 0 and 1. | |||
There was a problem hiding this comment.
I think the DCMeter is not limited to 0-1, it should be able to accept any number.
There was a problem hiding this comment.
When I use .getValue(), I see output values of -1 to 1 (which is an error and needs changed in this). The doc edit references that output, not the input. Am I understanding this incorrectly?
There was a problem hiding this comment.
I'm looking at this basic demo that I set up the other day: https://codepen.io/cjwit/pen/PozzrxP
There was a problem hiding this comment.
The audio output of PolySynth is in the audio range (-1 to 1), but if you connect something with a different value, you can see that the values are not limited to that range:
const meter = new Tone.DCMeter()
const signal = new Tone.Signal(4).connect(meter)There was a problem hiding this comment.
This is obviously related to me learning the system. Since a Signal appears to represent a wide range of types of values, it isn't clear to me what your example represents. (As in, I'm not sure what the "4" is relating to.) Since the point isn't troubleshooting here, I removed that language and pushed the change to the PR.
|
thanks @cjwit Sorry to sleep on this! helpful PR |
I added some detail to the documentation based on recent discussions in the Google Groups forum. This adds the HTML usage option to the main README file and adds some description and links between the Meter and DCMeter docs.
Related: is there a way to view the docs locally before pushing? Running
nom run docsgenerated the JSON file, but I don't want to make changes topackage.jsonto change that.Since this is my first time contributing, I ran tests and saw some failures, but they don't relate to this pull request so far as I can tell. If I did break the tests somehow, please let me know so that I can figure out how that works. I would like to be able to contribute more often, even if only to incorporate things into the docs.