Re: [PATCH] Fix documentation typos

Re: [PATCH] Fix documentation typos

[Laurent Bercot]

>-file named <tt>S6_FDHOLDER_STORE_REGEX</tt> is found is the <tt>env/</tt>
>+file named <tt>S6_FDHOLDER_STORE_REGEX</tt> is found in the <tt>env/</tt>

  Applied, thanks.


>-service readiness, you should give this option along with <tt>up</tt>: the service is ready iff
>+service readiness, you should give this option along with <tt>up</tt>: the service is ready if

  Not a typo. "iff" means "if and only if", as any mathematician will
tell you. :)

--
  Laurent

Re: [PATCH] Fix documentation typos

[Steve Litt]

Laurent Bercot said on Fri, 06 Jan 2023 11:58:55 +0000

>>-file named <tt>S6_FDHOLDER_STORE_REGEX</tt> is found is the
>><tt>env/</tt> +file named <tt>S6_FDHOLDER_STORE_REGEX</tt> is found
>>in the <tt>env/</tt>  
>
>  Applied, thanks.
>
>
>>-service readiness, you should give this option along with
>><tt>up</tt>: the service is ready iff +service readiness, you should
>>give this option along with <tt>up</tt>: the service is ready if  
>
>  Not a typo. "iff" means "if and only if", as any mathematician will
>tell you. :)

I'm not a mathematician, even though once upon a time I could do
partial differential equations. I didn't know iff meant "if and only
if". Just so everyone's on the same page, probably the easiest route to
docs everyone understands is to replace iff with "if and only if".

SteveT

Steve Litt 
Autumn 2022 featured book: Thriving in Tough Times
http://www.troubleshooters.com/bookstore/thrive.htm

Re: [PATCH] Fix documentation typos

[alice]

On Sat Jan 7, 2023 at 9:34 AM CET, Steve Litt wrote:
> Laurent Bercot said on Fri, 06 Jan 2023 11:58:55 +0000
>
> >>-file named <tt>S6_FDHOLDER_STORE_REGEX</tt> is found is the
> >><tt>env/</tt> +file named <tt>S6_FDHOLDER_STORE_REGEX</tt> is found
> >>in the <tt>env/</tt>  
> >
> >  Applied, thanks.
> >
> >
> >>-service readiness, you should give this option along with
> >><tt>up</tt>: the service is ready iff +service readiness, you should
> >>give this option along with <tt>up</tt>: the service is ready if  
> >
> >  Not a typo. "iff" means "if and only if", as any mathematician will
> >tell you. :)
>
> I'm not a mathematician, even though once upon a time I could do
> partial differential equations. I didn't know iff meant "if and only
> if". Just so everyone's on the same page, probably the easiest route to
> docs everyone understands is to replace iff with "if and only if".

as a passerby (and professional bike-shed designer), i would agree that is the
best solution. this isn't really a mathematical context, and it also has the
bonus of not looking like "domain-specific jargon" one can look up; an extra
letter merely looks like a typo to those that don't already know.

>
> SteveT
>
> Steve Litt 
> Autumn 2022 featured book: Thriving in Tough Times
> http://www.troubleshooters.com/bookstore/thrive.htm