GNOME Bugzilla – Bug 766111
Typos in reference manual and UI code
Last modified: 2016-05-16 14:43:58 UTC
There a number of typos in the reference manual in the latest git HEAD. I have found corresponding typos in the UI code for a few parts too. The attached patches aim to address all of these typos. The third patch attempts to use the <app> and <gui> tags consistently in the reference manual, please review this one thoroughly as I'm not sure you'll agree with where I decided to use the tags.
Created attachment 327442 [details] [review] Proposed patch 1/3.
Created attachment 327443 [details] [review] Proposed patch 2/3.
Created attachment 327444 [details] [review] Proposed patch 3/3.
(In reply to Sebastian Rasmussen from comment #1) > Created attachment 327442 [details] [review] [review] > Proposed patch 1/3. +1 for the user doc changes part in that patch, if the code maintainers agree on the string changes in the .c file
> +1 for the user doc changes part in that patch, if the code maintainers > agree on the string changes in the .c file Thank you! :) On the other hand this is how it should always be done (or the manuals should have some indirect references to gui elements and fail to build if the elements disappear).
Review of attachment 327443 [details] [review]: Thanks for the patch! I've left two minor comments, but this is definitely a big improvement and already ready to commitinto git master. Do you have GNOME Git commit/merge/push rights? ::: help/C/mail-filters.page @@ +35,2 @@ <steps> +<item><p>Click <guiseq><gui>Edit</gui><gui>Message Filters</gui></guiseq>, or click <guiseq><gui>Message</gui><gui>Create</gui></guiseq> and select the criterion the filter will be based on.</p></item> I'm not entirely sure if this should also mention the last sub-option under "Create". That's basically up to you. :) ::: help/C/mail-not-sent.page @@ +24,3 @@ <list> <item><p>Invalid email address. Check if all the addresses listed as mail recipients are correct. If the message contains a wrong or invalid email address, the message will not be sent.</p></item> +<item><p>Incorrect SMTP settings. Verify if the settings used for outgoing messages is correct. Using the incorrect server address or authentication method may prevent emails from being sent.</p></item> "if the settings used [...] is correct" should alsobe corrected. (That mistake existed already beforehand.)
Review of attachment 327444 [details] [review]: Looks good to commit into git master, except for one small typo. Thanks for working on this! ::: help/C/index.page @@ +25,3 @@ <span its:translate="yes">Evolution logo</span> </media> + <app> Evolution</app> Mail and Calendar This shouldn't have a whitespace between the tag and the word.
> Thanks for the patch! I've left two minor comments, but this is definitely a > big improvement and already ready to commitinto git master. Excellent. :) I found these while translating the documentation to Swedish, so I prepared a patch since I notice the errors. > Do you have GNOME Git commit/merge/push rights? No, I do not. I have been offered an account and commit rights by kittykat over at #docs on GNOME IRC. I'll generate a viable SSH-key and see if she can help me. > I'm not entirely sure if this should also mention the last sub-option under > "Create". That's basically up to you. :) So you mean that there is an additional sub-option that could be mentioned, but is currently not? I don't have evolution installed so I'd need help with what that option is in that case, then I can update the patch. > "if the settings used [...] is correct" should alsobe corrected. (That > mistake existed already beforehand.) Sure, no problem I'll update this and the whitespace before "Evolution" mentioned in comment #7.
Created attachment 327447 [details] [review] Proposed patch 2/3 Updated patch after review.
Created attachment 327448 [details] [review] Proposed patch 3/3. Updated patch after review.
Review of attachment 327442 [details] [review]: Thanks for the correction in the defaults page string, I overlooked it. I've only a query for the table-header-item part. ::: e-util/e-table-header-item.c @@ +1625,3 @@ G_CALLBACK (ethi_popup_sort_descending), 2), E_POPUP_ITEM ( + N_("_Unsorted"), G_CALLBACK (ethi_popup_unsort), 0), This option is used in a context menu above the header part of the message list (and in other list views). It currently reads: Sort -> (list of columns to pick from) Sort Ascending Sort Descending Unsort ... That is, the Unsort there is meant to be "Turn off sorting", aka "Do not sort at all". I think the "Unsorted" is not the same meaning.
If you agree on the patches with Andre (and the 1/3 with me), then I can commit for you. No need to postpone the changes for a long time.
I committed patches approved by Andre as: [2/3] Created commit ab41153 in evo master (3.21.2+) [3/3] Created commit cb3679d in evo master (3.21.2+) I'd still like to hear from you for the comment #11 first.
These patches have broken the build in Continuous for the past 4 hours: Error: Could not parse document: /ostbuild/source/evolution/_build/../help//C/intro-application.page:5: parser error : Opening and ending tag mismatch: app line 5 and desc <desc>An introduction to <app>Evolution<app>.</desc> ^ /ostbuild/source/evolution/_build/../help//C/intro-application.page:22: parser error : Opening and ending tag mismatch: app line 5 and info </info> ^ /ostbuild/source/evolution/_build/../help//C/intro-application.page:31: parser error : Opening and ending tag mismatch: desc line 5 and page </page> ^ /ostbuild/source/evolution/_build/../help//C/intro-application.page:32: parser error : Premature end of data in tag info line 4 ^ /ostbuild/source/evolution/_build/../help//C/intro-application.page:32: parser error : Premature end of data in tag page line 1 ^ Makefile:1036: recipe for target 'mk/mk.stamp' failed Could you please revert, so I don't have to tag Evolution?
(In reply to Emmanuele Bassi (:ebassi) from comment #14) > Could you please revert, so I don't have to tag Evolution? Followup fix in https://git.gnome.org/browse/evolution/commit/help/C?id=6de71be695750eb146a97b7e898b8fb12b15f00c
> I'd still like to hear from you for the comment #11 first. For me personally the verb "Unsort" sounds like "Randomize", i.e. having a different sort order every time, but I'm guessing that is not really what is happening..? Are they sorted by arrival order? Or can it be referred to as "Default sort order" or something similar? Also, sorry for messing up the </app>-tag. :/ Thanks for fixing it promptly!
Right, the Unsort is to sort by UID, thus basically by the order the messages had been added into the folder. Approximately said, because it can differ for different providers. What about "Reset sort"? Or if you think the "Default sort order" would not be confused with the View's sorting, like "set to the sort order I used before I accidentally clicked the column header", then that can be used too, from my point of view.
> What about "Reset sort"? Ah, good idea. Sounds excellent and would make sense after translating as well. I'll update the patch.
Created attachment 327975 [details] [review] Proposed patch 1/3.
Thanks for the update. I committed it to sources: Created commit 2815187 in evo master (3.21.2+)
*** Bug 766416 has been marked as a duplicate of this bug. ***