Audacity Bug Summary
••• Introduction •••
••• Keywords •••
    Audacity 3.0.3 development began 19th April 2021

Audacity Bugzilla



Bug 1316 - Description message is ungrammatical in Generate Chirp
Description message is ungrammatical in Generate Chirp
Status: RESOLVED QUICKFIXED
Product: Audacity
Classification: Unclassified
Component: Built-in FX
2.1.3
Per OS Other
: P4 Repeatable
Assigned To: Steve Daulton
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2016-01-27 07:05 UTC by Peter Sampson
Modified: 2018-08-20 11:51 UTC (History)
6 users (show)

See Also:
Steps To Reproduce:
Release Note:
First Git SHA:
Group: ---
Workaround:
Closed: 2018-08-20 00:00:00


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Sampson 2016-01-27 07:05:07 UTC
If you use the "Manage" button in Generate>Chirp and then select the "About" button you will see that "Description" field is ungrammatical, and doesn't really make sense, it says:

"Generates four different types of tone waveform while allowing starting and ending amplitude and fequency"

I assume that this means that you can manage and control the starting and ending stuff - but it doesn't really say that.
Comment 1 Steve Daulton 2016-01-27 08:34:25 UTC
The first part of the description matches the description for the Tone generator, which is good because Chirp is the same as the Tone generator but has the added features of being able to set the initial and final peak amplitudes and frequencies. It's quite difficult to say that briefly enough. What do you suggest?
Comment 2 Peter Sampson 2016-01-27 08:36:47 UTC
how about


"Generates four different types of tone waveform with control of starting and ending amplitude and fequency"
Comment 3 Peter Sampson 2016-01-28 06:36:22 UTC
(In reply to Peter Sampson from comment #2)
Or how about the simpler:

"Generates four different types of tone waveform"

One can clearly see from the dialog GUI that there are front/back-end controls.
Comment 4 Peter Sampson 2016-05-07 11:29:23 UTC
The situation is worse on Aplle Mac as the message is too long, you get:

"Generates four different types of tine wavefor...hile allowing starting and ending amplitude and frequency"

with the mesaage truncated in the middle with the ellipsis
Comment 5 Peter Sampson 2016-05-07 11:35:47 UTC
And latterly I now think the message should simply say:

"Generates four different types of chirp waveform"
Comment 6 Steve Daulton 2016-05-07 13:22:29 UTC
(In reply to Peter Sampson from comment #5)
What's a "chirp"?
With the default settings it does not sound like my idea of a "chirp".
Comment 7 Peter Sampson 2016-05-07 13:33:35 UTC
(In reply to Steve Daulton from comment #6)
So, Steve, are you suggesting we change the name of this generator?
Comment 8 Steve Daulton 2016-05-07 13:45:49 UTC
(In reply to Peter Sampson from comment #7)
No, not at this time, but I think the description needs to be descriptive ;-)

Perhaps: "Generates tones from one frequency to another."
or could be "sliding tones" or something similar.
Comment 9 Gale Andrews 2016-05-08 19:23:01 UTC
(In reply to Peter Sampson from comment #4)
> The situation is worse on Aplle Mac as the message is too long, 
I added this at Bug 1388. 

I like the description saying that there are four different types of tone. My suggestion for Tone:  

"Generates a constant frequency tone of one of four types.

and for Chirp:

"Generates an ascending or descending tone of one of four types.
Comment 10 Peter Sampson 2016-05-09 04:12:26 UTC
I like Gale's suggested wording +1
Comment 11 Steve Daulton 2016-05-09 04:21:39 UTC
(In reply to Gale Andrews from comment #9)
Done in https://github.com/audacity/audacity/commit/15fe0763
Comment 12 Gale Andrews 2016-05-09 07:44:10 UTC
Thanks, Steve.