[pmg-devel] [PATCH docs] pmgconfig: grammar, phrasing and typo fixes

[Thomas Lamprecht]

On 4/21/20 5:18 PM, Oguz Bektas wrote:
> hi,
> 

First, please avoid top-posting, this makes reading and answering unnecessarily
harder… I tried to correct it here to have the context..

> On Tue, Apr 21, 2020 at 05:14:14PM +0200, Aaron Lauterer wrote:
>>> @@ -306,12 +306,12 @@ include::pmg.mail-options-conf-opts.adoc[]
>>>   Before and After Queue scanning
>>>   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>> -Scanning email can happen at two different stages of mail-processing:
>>> +Scanning e-mail can happen at two different stages of mail-processing:
>> in english both works, e-mail as well as email. Maybe we should decide which
>> one we want to use and be consistent.
>> 
>> https://grammarist.com/style/e-mail-email/


> 'e-mail' is the way it was written in the rest of the files so i opted
> for that one.

That's not fully true, we have roughly about half and half usage of email
vs e-mail which a grep shows (the silver searches has even a real "count"
option, not only a count-lines-with-matches).

Our internal style guide implicitly goes for "email".
http://intranet.proxmox.com/index.php/Technical_Writing_Style_Guide#Hyphens

> On 4/21/20 5:14 PM, Aaron Lauterer wrote:
>>>   @@ -577,11 +577,11 @@ slightly adjusting the score of a particular rule. Two examples:
>>>     'DEAR_SOMETHING'). By setting the score of this rule to 0 you can disable
>>>     it completely.
>>>   -The system logs all rules which particular mail hits. Analyzing the logs can
>>> +The system logs all the rules which a particular mail hits. Analyzing the logs can
>>>   lead to finding such a pattern in your environment.
>>>     You can adjust the score of a rule by creating a new 'Custom Rule Score' entry
>>> -in the GUI.
>>> +on the GUI.
>> 
>> I would opt for "in the GUI". In the interface, not on the interface :/
>> 
>> couldn't find much online but https://forum.wordreference.com/threads/in-the-gui-or-on-the-gui.3332406/
> > 'on the GUI' vs. 'in the GUI', i feel that 'on' fits better since the
> GUI is on the screen. if preferred i can change to 'in'
> 


That is IMO a straw man argument. A poster is also on the wall, but if I
want to point something out *in* the poster the wall is irrelevant.
Just because the interface is visible on a screen that holds no value for
talking about things in the interface. Definitively with Aaron here.