patch to repair typos in comments

18 messages

patch to repair typos in comments

Reply Threaded

Am I being obsessive? Both of these caused me to scratch my head and the
second one actually cost me quite a bit of time.

Both of these are typos in comments -- I know they do not matter to the user
but for someone trying to maintain, develop or debug Audacity small items
like this can be very annoying.

Please find attached a patch to repair these.

typo?
in file Prefs.cpp line 15:
Audacity uses wxWindows' wxConfig class
should be:
Audacity uses wxWidgets' wxConfig class

typo?
in Menus.cpp lines 884-887:
// Effect Menu

//////////////////////////////////////////////////////////////////////////

c->BeginMenu(_("&Analyze"));
should be:

// Analyze Menu

//////////////////////////////////////////////////////////////////////////

c->BeginMenu(_("&Analyze"));

--Ed

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

typo1.patch (1K) Download Attachment

Gale (Audacity Team)

Re: patch to repair typos in comments

Reply Threaded

| From "Ed Musgrove" <[hidden email]>
| Sat, 17 Oct 2009 14:17:09 -0700
| Subject: [Audacity-devel] patch to repair typos in comments

> Am I being obsessive? Both of these caused me to scratch my head and the
> second one actually cost me quite a bit of time.
>
> Both of these are typos in comments -- I know they do not matter to the user
> but for someone trying to maintain, develop or debug Audacity small items
> like this can be very annoying.
>
> Please find attached a patch to repair these.
>
> typo?
> in file Prefs.cpp line 15:
> Audacity uses wxWindows' wxConfig class
> should be:
> Audacity uses wxWidgets' wxConfig class

I have not committed that because I don't believe your change is
correct - it should be changed to "wxFileConfig" (though I've
noticed "wxWindows" before and been a bit confused).

Prefs.h states "Audacity uses wxWindows' wxFileConfig class to
handle preferences. In Audacity versions prior to 1.3.1, it used
wxConfig, which would store the prefs in a platform-dependent
way (e.g. in the registry on Windows).

Maybe someone who knows more can clarify. See below...

> typo?
> in Menus.cpp lines 884-887:
> // Effect Menu
>
> //////////////////////////////////////////////////////////////////////////
>
> c->BeginMenu(_("&Analyze"));
> should be:
>
> // Analyze Menu
>
> //////////////////////////////////////////////////////////////////////////
>
> c->BeginMenu(_("&Analyze"));

I've committed the change replacing the duplicated comment referring
to the Effect menu with "Analyze Menu".

Gale

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Ed Musgrove-2

Re: patch to repair typos in comments

Reply Threaded

Looking at the website:
http://docs.wxwidgets.org/stable/wx_wxwindow.html#wxwindow
which seems to be the official documentation for wxWidgets, I see:
wxWindow
wxWindow is the base class for all windows [...]

Derived from

wxEvtHandler
wxObject

Following back up the inheritance chain (wxEvtHandler & wxObject) I note
that neither wxWindow nor either of the classes from which it inherits have
either wxConfig or wxFileConfig in their inheritance. I still think this
might be a mistake.

--Ed

> -----Original Message-----
> From: Gale Andrews [mailto:[hidden email]]
> >
> > typo?
> > in file Prefs.cpp line 15:
> > Audacity uses wxWindows' wxConfig class should be:
> > Audacity uses wxWidgets' wxConfig class
>
> I have not committed that because I don't believe your change is correct -
it
> should be changed to "wxFileConfig" (though I've noticed "wxWindows"
> before and been a bit confused).
>
> Prefs.h states "Audacity uses wxWindows' wxFileConfig class to handle
> preferences. In Audacity versions prior to 1.3.1, it used wxConfig, which
> would store the prefs in a platform-dependent way (e.g. in the registry on
> Windows).

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Gale (Audacity Team)

Gale Andrews wrote:
> | From "Ed Musgrove" <[hidden email]>
....
>> typo?
>> in file Prefs.cpp line 15:
>> Audacity uses wxWindows' wxConfig class
>> should be:
>> Audacity uses wxWidgets' wxConfig class
>
> I have not committed that because I don't believe your change is
> correct - it should be changed to "wxFileConfig" (though I've
> noticed "wxWindows" before and been a bit confused).

It was originally called wxWindows, and then renamed when Microsoft
threatened legal action.

IMO, discussing these trivialities at length is bordering on misuse of
attention bandwidth.

- V

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Ed Musgrove-2

Re: patch to repair typos in comments

Reply Threaded

My humble apologies.

--Ed

> -----Original Message-----
> From: Vaughan Johnson [mailto:[hidden email]]
>
> IMO, discussing these trivialities at length is bordering on misuse of
attention
> bandwidth.

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Gale (Audacity Team)

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Vaughan Johnson

| From Vaughan Johnson <[hidden email]>
| Sun, 18 Oct 2009 13:36:08 -0700
| Subject: [Audacity-devel] patch to repair typos in comments

> Gale Andrews wrote:
> > | From "Ed Musgrove" <[hidden email]>
> ....
> >> typo?
> >> in file Prefs.cpp line 15:
> >> Audacity uses wxWindows' wxConfig class
> >> should be:
> >> Audacity uses wxWidgets' wxConfig class
> >
> > I have not committed that because I don't believe your change is
> > correct - it should be changed to "wxFileConfig" (though I've
> > noticed "wxWindows" before and been a bit confused).
>
> It was originally called wxWindows, and then renamed when Microsoft
> threatened legal action.

Thanks, that clarifies it.

> IMO, discussing these trivialities at length is bordering on misuse of
> attention bandwidth.

Don't agree with you there, either that out-of-date/incorrect comments
in the code are necessarily "trivial" to someone learning that code, or
that the responses made here were of excessive length.

Obviously someone who knew the answer for sure/noticed the typo and
who had write access would just commit the change without writing here.
A new developer does not have those rights.

Gale

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Ed Musgrove-2

Thanks, Ed. The volume of emails, especially long emails, has really
skyrocketed lately. Not saying it's all trivialities, but it's become
quite time-consuming just to check the emails, even if I have no
response/comments on the threads, because I don't want to miss anything
that I do have comments on. I think I'm not alone in this.

- Vaughan

Ed Musgrove wrote:

> My humble apologies.
>
> --Ed
>
>
>> -----Original Message-----
>> From: Vaughan Johnson [mailto:[hidden email]]
>>
>> IMO, discussing these trivialities at length is bordering on misuse of
> attention
>> bandwidth.

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Ed Musgrove-2

Re: patch to repair typos in comments

Reply Threaded

If we could convince everyone on the list to drastically edit out all the
repetitive duplications of previous replies at the bottom that would help
immensely. Editing out those sections of the most recent reply which are not
pertinent helps to. I realize that I may be posting too many times and I
know that I'm way too verbose!

--Ed

> -----Original Message-----
> From: Vaughan Johnson [mailto:[hidden email]]
>
> Thanks, Ed. The volume of emails, especially long emails, has really
> skyrocketed lately.

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Gale (Audacity Team)

Gale Andrews wrote:
> | From Vaughan Johnson <[hidden email]>
>...
>
>> IMO, discussing these trivialities at length is bordering on misuse of
>> attention bandwidth.
>
> Don't agree with you there, either that out-of-date/incorrect comments
> in the code are necessarily "trivial" to someone learning that code, or
> that the responses made here were of excessive length.

You're disagreeing with something I didn't say. It's fine to fix them,
but I was objecting to a discussion where neither of you knew the
answer. Once the question had been posed, why not wait until somebody
who actually knows responded, rather than speculating/wondering "out loud"?

And this particular one wasn't horrible, but it's the trend I wanted to
comment on. (And Ed, this is one that has a history -- I occasionally
plead with the list for brevity and focus.)

There are nearly 400 people on this list. Please be respectful of their
time. That's all I was trying to say.

- Vaughan

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Ed Musgrove-2

Ed Musgrove wrote:
> If we could convince everyone on the list to drastically edit out all the
> repetitive duplications of previous replies at the bottom that would help
> immensely. Editing out those sections of the most recent reply which are not
> pertinent helps to.

+1 to both those comments.

> I realize that I may be posting too many times and I
> know that I'm way too verbose!

Well, I know people who think I'm too terse, even laconic. But I think
that's appropriate for technical discussions. :-)

Thanks, Ed.

- Vaughan

>
>
>> -----Original Message-----
>> From: Vaughan Johnson [mailto:[hidden email]]
>>
>> Thanks, Ed. The volume of emails, especially long emails, has really
>> skyrocketed lately.
>

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Gale (Audacity Team)

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Ed Musgrove-2

| From "Ed Musgrove" <[hidden email]>
| Mon, 19 Oct 2009 12:40:02 -0700
| Subject: [Audacity-devel] patch to repair typos in comments
> If we could convince everyone on the list to drastically edit out all the
> repetitive duplications of previous replies at the bottom that would help
> immensely. Editing out those sections of the most recent reply which are not
> pertinent helps to. I realize that I may be posting too many times and I
> know that I'm way too verbose!

Yes, but editing out context from previous replies can go
too far (I actually think you do go too far with that
sometimes, Ed, I've had to go back to earlier e-mails for
reference. :=)

Within reason, the context underneath the signature does
not matter for length of posts, because the reader knows the
signature is the end of all you have to say, and they don't
need to read beyond that.

Vaughan says "The volume of emails, especially long emails,
has really skyrocketed lately. Not saying it's all trivialities, but
it's become quite time-consuming just to check the emails,
even if I have no response/comments on the threads, because
I don't want to miss anything... I think I'm not alone in this."

You are definitely not alone. As I am supposed to be "tracking"
issues, this problem is especially true for me.

All I would add:

* IMO, we shouldn't discourage reports of typos/outdated
comments in the code. If someone on the list who does not
have write permission wants to report them, you could
perhaps e-mail [hidden email], or me,
to keep if off -devel.

Having said that, I found Vaughan's answer to the
"wxWindows" question well worth having on -devel
(so archived), because that was before my involvement
in the project, and that will be true for others too.

* Let's remember we have the Wiki:
http://wiki.audacityteam.org/

It's an option for discussing things like label track
behaviour or window behaviour, and linking to
that discussion here.

* If two people are asking each other questions during
testing, consider making the bulk of these e-mails
between yourselves, just posting the outcome to -devel.

My 2p....

Gale

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Ed Musgrove-2

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Vaughan Johnson

> From: Vaughan Johnson
> Well, I know people who think I'm too terse, even laconic. But I think
that's
> appropriate for technical discussions. :-)

[Ed:]

_DISAGREE_ technical ergo comprehension==(extreme clarity);
defineTerms();
explicitSteps {
communication = concise + specific;
}
reiterateFinalAgreement() //insure parties
buy into "it"

--Ed <grin>

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Gale (Audacity Team)

Gale Andrews wrote:
> | ...
>
> Vaughan says "The volume of emails, especially long emails,
> has really skyrocketed lately. ... I think I'm not alone in this."
>
> You are definitely not alone. As I am supposed to be "tracking"
> issues, this problem is especially true for me.
>
> All I would add:...
+1 on those suggestions, Gale.

- V

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Ed Musgrove-2

Beautiful, but I don't think it's a _DISAGREE_ -- at its heart is
"concise". Hooray for that. :-)

- V

Ed Musgrove wrote:

>> From: Vaughan Johnson
>> Well, I know people who think I'm too terse, even laconic. But I think
> that's
>> appropriate for technical discussions. :-)
>
> [Ed:]
>
> _DISAGREE_ technical ergo comprehension==(extreme clarity);
> defineTerms();
> explicitSteps {
> communication = concise + specific;
> }
> reiterateFinalAgreement() //insure parties
> buy into "it"
>
> --Ed <grin>
>

Gale (Audacity Team)

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Vaughan Johnson

| From Vaughan Johnson <[hidden email]>
| Mon, 19 Oct 2009 13:51:38 -0700
| Subject: [Audacity-devel] patch to repair typos in comments

> Gale Andrews wrote:
> > | From Vaughan Johnson <[hidden email]>
> >...
> >
> >> IMO, discussing these trivialities at length is bordering on misuse of
> >> attention bandwidth.
> >
> > Don't agree with you there, either that out-of-date/incorrect comments
> > in the code are necessarily "trivial" to someone learning that code, or
> > that the responses made here were of excessive length.
>
> You're disagreeing with something I didn't say. It's fine to fix them,
> but I was objecting to a discussion where neither of you knew the
> answer. Once the question had been posed, why not wait until somebody
> who actually knows responded, rather than speculating/wondering "out loud"?

Simply because I chose to commit the one I did know the answer to
(because that was an improvement), so had to give some reason
for not committing the other! It's always possible no-one might
answer, given how busy we are.

And I think we all might sometimes say we don't know, but try to give
a pointer. Maybe I've even seen you do that once or twice, or was
I dreaming? :=)

Gale

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

In reply to this post by Ed Musgrove-2

I went ahead and replaced all "wxWindows" occurrences with "wxWidgets".
There were 32 of them, not just the one in Prefs.cpp.

Btw, Gale, wxFileConfig is a wxConfig, so it's correct to say Audacity
uses wxConfig, and I left those.

- Vaughan

Ed Musgrove wrote:

Gale (Audacity Team)

Re: patch to repair typos in comments

Reply Threaded

| From Vaughan Johnson <[hidden email]>
| Tue, 20 Oct 2009 16:09:17 -0700
| Subject: [Audacity-devel] patch to repair typos in comments
> I went ahead and replaced all "wxWindows" occurrences with "wxWidgets".
> There were 32 of them, not just the one in Prefs.cpp.
>
> Btw, Gale, wxFileConfig is a wxConfig, so it's correct to say Audacity
> uses wxConfig, and I left those.

I see, just as well I didn't change that, then. Thanks for taking time
to doing the replacements.

Gale

> Ed Musgrove wrote:
> > Am I being obsessive? Both of these caused me to scratch my head and the
> > second one actually cost me quite a bit of time.
> >
> > Both of these are typos in comments -- I know they do not matter to the user
> > but for someone trying to maintain, develop or debug Audacity small items
> > like this can be very annoying.
> >
> > Please find attached a patch to repair these.
> >
> > typo?
> > in file Prefs.cpp line 15:
> > Audacity uses wxWindows' wxConfig class
> > should be:
> > Audacity uses wxWidgets' wxConfig class
> > ...
>
> ------------------------------------------------------------------------------
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart your
> developing skills, take BlackBerry mobile applications to market and stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> audacity-devel mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/audacity-devel

Vaughan Johnson

Re: patch to repair typos in comments

Reply Threaded

Gale Andrews wrote:
> | From Vaughan Johnson <[hidden email]>
> |
>> I went ahead and replaced all "wxWindows" occurrences with "wxWidgets".
>> There were 32 of them, not just the one in Prefs.cpp.
>>
>> ... Thanks for taking time
> to doing the replacements.

Cheers. :-)

Of course, afterward I thought, "Oh no, the evidence of how old those
pieces of code are is now disappeared." I think one of the comments was
"this will be fixed in wxWindows 2.3" -- so that code probably needs
reworking and the antiquity of the comment is important information. At
least it still says 2.3, but sometimes the visibly old age of the code
is informative.

- V

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel