Thread overview
[Issue 13467] A little better std.algorithm.canFind documentation
September 18, 2014
https://issues.dlang.org/show_bug.cgi?id=13467

hsteoh@quickfur.ath.cx changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |hsteoh@quickfur.ath.cx

--- Comment #1 from hsteoh@quickfur.ath.cx ---
Does "among" work for substrings? I.e., does among("XabcY", "abc", "def") return true? If not, I'm not sure I see the point of mentioning this in the docs for canFind, since they would cover different functionalities.

--
September 18, 2014
https://issues.dlang.org/show_bug.cgi?id=13467

--- Comment #2 from bearophile_hugs@eml.cc ---
(In reply to hsteoh from comment #1)
> Does "among" work for substrings? I.e., does among("XabcY", "abc", "def") return true? If not, I'm not sure I see the point of mentioning this in the docs for canFind, since they would cover different functionalities.

I think Phobos functions should have a "Related" section for the related functions. This helps a lot the discoverability of functions.

As example, this Haskell documentation page of the function "head" has a "Related" section that links to the drop, dropWhile, init, last, tail functions.

http://zvon.org/other/haskell/Outputprelude/head_f.html

--
September 18, 2014
https://issues.dlang.org/show_bug.cgi?id=13467

--- Comment #3 from hsteoh@quickfur.ath.cx ---
Good idea! I'll add a Related section to canFind.

--
September 18, 2014
https://issues.dlang.org/show_bug.cgi?id=13467

hsteoh@quickfur.ath.cx changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Keywords|                            |pull

--- Comment #4 from hsteoh@quickfur.ath.cx ---
Done: https://github.com/D-Programming-Language/phobos/pull/2532

Renamed it to "See Also:" instead, since that is what is used by the ddocs of a few other functions in std.algorithm.

--
September 19, 2014
https://issues.dlang.org/show_bug.cgi?id=13467

--- Comment #5 from github-bugzilla@puremagic.com ---
Commits pushed to master at https://github.com/D-Programming-Language/phobos

https://github.com/D-Programming-Language/phobos/commit/0b6bfd5aa73ef134659f21d36e7f1b7f0d2cfe5f Cross-reference `among` from `canFind`.

For newbies' ease of discovering the right function to use (issue 13467).

https://github.com/D-Programming-Language/phobos/commit/bf4cadbb4b4f393a2ab4b6f9e86e8e3c9650f94c Merge pull request #2532 from quickfur/issue13467

Cross-reference `among` from `canFind`.

--
September 19, 2014
https://issues.dlang.org/show_bug.cgi?id=13467

hsteoh@quickfur.ath.cx changed:

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

--
September 20, 2014
https://issues.dlang.org/show_bug.cgi?id=13467

--- Comment #6 from github-bugzilla@puremagic.com ---
Commit pushed to master at https://github.com/D-Programming-Language/phobos

https://github.com/D-Programming-Language/phobos/commit/a9e7f0beebee5b06cdc87a03971c25b53b042296 Merge pull request #2545 from JakobOvrum/issue13467

Tweak #2532

--