GNOME Bugzilla – Bug 674364
gnome-terminal-prefs documentation is outdated
Last modified: 2013-03-03 23:18:05 UTC
Also reported on: https://bugs.launchpad.net/ubuntu/+source/gnome-terminal/+bug/883972. When clicking the help button from the dialog appearing on Edit->Profile Prefences, the displayed help page (gnome-terminal-prefs) contains some outdated information and inconsistency with the interface displayed: - the Colors tab is spelled in the help as Colours - the next tab after Colors is called Effects in the help, while in the interface it is called Background - the first sentence of the help page states: To configure GNOME Terminal, choose Edit->Current Profile, but on the interface the menuitem is labeled Profile Preferences, not Current Profile.
Created attachment 229791 [details] [review] Patch to fix the above issues
Hi Aruna, thanks a lot for the patch! Some quick comments (note though that I'm not a gnome-terminal maintainer:) > Bug: 674364 Bugzilla This should be more descriptive and self-explaining without making me look up that report in Bugzilla first to get an idea what your patch is about. > Changed all occurences of "colour" to read as "color" and made other > edits as required to solve the bug. Same here, writing "required to solve the bug" is not useful in a commit summary as nobody knows "the bug". You should summarize in your words what you've changed and why (and you've done that already partially). > + No need to add an empty line here. > + To configure <application>&app;</application>, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Profile Preferences</guimenuitem></menuchoice>. To configure another profile that you set up choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Profiles</guimenuitem></menuchoice>, select the profile you want to edit, then click <guibutton>Edit</guibutton>. </para> The two whitespaces in "</guibutton>. </para>" should go, but this was already wrong before so I understand that it's not part of this report. + The <guilabel>Profile Preferences</guilabel> dialog contains the following tabbed sections that you can use to configure <application>&app;</application>: </para> The unneeded whitespace in "</application>: </para>" should go, but this was already wrong before and not introduced by your patch, so I understand that it's not part of this report. + Select the <guilabel>Use colors from system theme</guilabel> option to use the colors that are specified in the GNOME Desktop theme that is selected in the <guilabel>Theme</guilabel> tab of the <ulink type="help" url="help:user-guide/prefs-theme"><application>Appearance</application> preference tool</ulink>. I have huge doubts that these (unchanged) links still work. Did you test this (by opening your patched helpfile with the GNOME's "yelp" help browser)? I get an error "The URI ‘ghelp:user-guide?prefs-theme#prefs-theme’ does not point to a valid page." when clicking the "user-guide/prefs-theme" link, as the user guide is dead since 2.32 (see http://library.gnome.org/users/user-guide/ for the last version). It has been replaced by http://library.gnome.org/users/gnome-help/ but I am not sure if that covers how to change themes at all, since GNOME3 only allows changing themes by using gnome-tweak-tool which is not "officially" included and hence not covered by the user docs.
Created attachment 229793 [details] [review] Previous patch with reflow. :)
Thank you, for the detailed review. I am super-sleepy now. It's almost 4.00 a.m. in India. I'll work on the review tomorrow. :) I saw your review after I submitted the second patch, so sorry that I didn't use anything that you suggested. I'll work on it tomorrow. :)
Created attachment 230304 [details] [review] Changes according to Andre's review.
Review of attachment 230304 [details] [review]: The subject/title of the patch should indicate that you are editing the user help. For example: "Minor corrections to user help, bug 674364 Changed all the occurences of colour to read as color. Also worked on eliminating some minor discrepancies between the documentation and actual options on the terminal." ::: help/C/index.docbook @@ +794,3 @@ Preferences</guimenuitem></menuchoice>. To configure another profile that you set up choose +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Profiles...</guimenuitem></menuchoice>,select Always use ellipsis (…) instead of three dots. Add a space after the comma. @@ +797,3 @@ +the profile you want to edit, then click <guibutton>Edit</guibutton> + </para> + <para> The indenting on one of the above two lines is wrong, fix it.
Created attachment 230322 [details] [review] Changes on Kat's review
Created attachment 230323 [details] [review] Changes on Kat's review
Created attachment 230334 [details] [review] Version 2
Review of attachment 230334 [details] [review]: Fix the whitespaces that I mentioned on IRC, and the comments below, and that should be it! ::: help/C/index.docbook @@ +804,3 @@ + <itemizedlist> + <listitem><para> + Remove this blank line @@ +984,3 @@ +selected in the<guilabel>Theme</guilabel> tab of the <ulink type="help" +url="help:user-guide/prefs-theme"><application>Appearance</application>preference +tool</ulink>. Remove the links (<ulink> tags) as they don't work.
Created attachment 230345 [details] [review] Version3 :D
Created attachment 230350 [details] [review] Version 3
The help has now been re-written in Mallard and the issue no longer exists, closing as obsolete.