Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggested rewording in 1.3 Signals? #106

Open
kjcole opened this issue Jun 29, 2024 · 0 comments
Open

Suggested rewording in 1.3 Signals? #106

kjcole opened this issue Jun 29, 2024 · 0 comments

Comments

@kjcole
Copy link

kjcole commented Jun 29, 2024

Perhaps it's just me, but when I get to phrases like "this example" and the phrase is separated from the actual example by two paragraphs and a figure, I stumble, asking "What example?". Personally, I would find the following wording to be a tad clearer, as it tells me whether I should be looking backwards or forwards for said example:

Signal provides make_wave, which returns a new Wave object. In the following example

wave = mix.make_wave(duration=0.5, start=0, framerate=11025)

duration is the length of the Wave in seconds. start is the start time, also in seconds. framerate is the (integer) number of frames per second, which is also the number of samples per second.

11,025 frames per second is one of several framerates commonly used in audio file formats, including Waveform Audio File (WAV) and mp3.

The above statement evaluates the signal from t=0 to t=0.5 at 5,513 equally-spaced frames (because 5,513 is half of 11,025). The time between frames, or timestep, is 1/11025 seconds, about 91 µs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant