Thread overview
[Issue 5912] New: Small typos throughout Phobos and DMD documentation
Apr 30, 2011
Andrej Mitrovic
Apr 30, 2011
Walter Bright
Apr 30, 2011
kennytm@gmail.com
Apr 30, 2011
Walter Bright
Apr 30, 2011
Andrej Mitrovic
Apr 30, 2011
Walter Bright
May 25, 2011
Andrej Mitrovic
May 25, 2011
Vladimir Panteleev
April 30, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912

           Summary: Small typos throughout Phobos and DMD documentation
           Product: D
           Version: D2
          Platform: Other
        OS/Version: Windows
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Phobos
        AssignedTo: nobody@puremagic.com
        ReportedBy: andrej.mitrovich@gmail.com


--- Comment #0 from Andrej Mitrovic <andrej.mitrovich@gmail.com> 2011-04-30 13:26:06 PDT ---
These are from the 2.052 release.

std.range:

line 207: returns $(D false) iff change to: returns $(D false) if

line 580: iff the range supports change to: if the range supports

line 1982: iff there are no more
change to: if there are no more

line 2843: offers random access iff change to: offers random access if

std.conv:

line 3839: Give an unsigned iff change to: Give an unsigned if

std.encoding:

line 1298: Returns true iff
change to: Returns true if

std.traits:

line 2225: Returns $(D true) iff
change to: Returns $(D true) if

std.variant:

line 251: Returns: true iff change to: Returns: true if

src/dmd/backend/el.c:

line 2031: Needed iff floating point
change to: Needed if floating point

It looks like someone needs a new keyboard! :)

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
April 30, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912


Walter Bright <bugzilla@digitalmars.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |bugzilla@digitalmars.com


--- Comment #1 from Walter Bright <bugzilla@digitalmars.com> 2011-04-30 13:43:57 PDT ---
(In reply to comment #0)
> It looks like someone needs a new keyboard! :)

Well, ffffudge that!

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
April 30, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912


kennytm@gmail.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |kennytm@gmail.com


--- Comment #2 from kennytm@gmail.com 2011-04-30 14:07:02 PDT ---
Meh. "iff" means "if and only if". I'd say WONTFFFFFIX.

http://en.wikipedia.org/wiki/Iff

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
April 30, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912


Walter Bright <bugzilla@digitalmars.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |INVALID


--- Comment #3 from Walter Bright <bugzilla@digitalmars.com> 2011-04-30 14:14:51 PDT ---
(In reply to comment #2)
> "iff" means "if and only if".

Kenny's right.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
April 30, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912



--- Comment #4 from Andrej Mitrovic <andrej.mitrovich@gmail.com> 2011-04-30 14:19:12 PDT ---
Wow, I've never heard of this before. Do you expect non-english readers to know about this in advance?

On the upside it does seem to be a proper word: http://en.wikipedia.org/wiki/If_and_only_if

But if it saves you a couple of bytes of precious and expensive hard drive space (dollars per gallon of bytes is expensive these days!) then go for it!

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
April 30, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912



--- Comment #5 from Walter Bright <bugzilla@digitalmars.com> 2011-04-30 15:07:49 PDT ---
(In reply to comment #4)
> Wow, I've never heard of this before. Do you expect non-english readers to know about this in advance?

I have no idea what non-native english speakers know about various jargons of english, and I don't think it's fair to presumptively patronize anyone by dumbing down the use of technical jargon.

I've seen iff used by math/science types in and since college. Note that Andrei learned english rather late in life, and he's the author of some of those instances.

If there are terms someone isn't familiar with, there's no harm in asking. We're happy to help.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
April 30, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912


Andrei Alexandrescu <andrei@metalanguage.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |andrei@metalanguage.com


--- Comment #6 from Andrei Alexandrescu <andrei@metalanguage.com> 2011-04-30 16:48:49 PDT ---
The general Merriam-Webster dictionary lists the word (http://www.merriam-webster.com/dictionary/iff) which supports closing the bug as invalid. Thanks Andrej for the scrutiny.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
May 25, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912



--- Comment #7 from Andrej Mitrovic <andrej.mitrovich@gmail.com> 2011-05-25 07:31:03 PDT ---
I have come out too harsh in my reply, apologies to Walter && Andrei. Now that I've actually learned what it means I've noticed it does seem to be present in a lot of other projects' documentation files around the 'net. I probably never even noticed 'iff' before since I've never known it had a special meaning, so I assumed it was just a common typo. It does seem that some people prefer italicizing 'iff' to make it stand out more in the documentation.

Anyway, this is bikeshedding. I'm sorry iff I've wasted anyone's time here. :)

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
May 25, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=5912


Vladimir Panteleev <thecybershadow@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |thecybershadow@gmail.com


--- Comment #8 from Vladimir Panteleev <thecybershadow@gmail.com> 2011-05-25 07:33:43 PDT ---
May I suggest using the HTML "abbr" tag for this?

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------