229594 - Update help for command

Status: RESOLVED FIXED

(Other Applications :: ChatZilla, defect)

Description

[James Ross]

It has come to my attention that some of the help messages for commands are
either confusing, or in some cases actually wrong. This bug is to update those
that need it, and make sure localisers know about these changes (please add CCs
as needed).

To those CCed: I've tried to find people who are doing localisations of
ChatZilla; if you're not, please accept my apology and un-CC yourself.

Comment 1

[James Ross]

Initial list: channel-pref, delete-view, leave, network-pref, user-pref.

The pref ones just need (I think) correcting from <pref-name> to <pref-value>
when talking about using '-'. /delete-view needs to mention that is leaves
channels now, and /leave doesn't make it clear what the difference between it
and /delete and /hide is.

Comment 2

[:Gijs (he/him)]

Attachment: Patch for the commands mentioned in comment #1, as well as plugin-pref

Lingering bug. I hope everyone approves of these changes. 

I'm actually also kind of ashamed that I blindly copied the mistakes from one
of the other helps when I added the plugin-pref command. Well, at least this
fixes that :-)

Comment 3

[James Ross]

Comment on attachment 170078 [details] [diff] [review]
Patch for the commands mentioned in comment #1, as well as plugin-pref

>Index: extensions/irc/xul/locale/en-US/chatzilla.properties
>+cmd.leave.help   = Leaves the current channel, use /delete or /hide to force the view to go away. Doing /delete removes any content on that tab and destroys it, while /hide remembers the content and will display it again when rejoining the channel. Many servers do not support the optional <reason> parameter.  If you are dispatching this command from script, you may also specify the <no-delete> parameter.  If this is provided and is |true|, |on|, |yes|, or |1|, the the tab will not be deleted.

I don't like the second sentence... how about this, instead of the first two
sentences?

"Leaves the current channel.  Use /delete to force the view to go away, losing
its contents, or /hide to temporarily hide it, preserving its contents."

Comment 4

[:Gijs (he/him)]

Attachment: Patch v2

New patch, with changes suggested by Silver.

Comment 5

[James Ross]

Checked in --> FIXED.