On Sunday, 27 July 2014 at 06:10:09 UTC, Andrei Alexandrescu wrote:
On 7/26/14, 8:47 PM, H. S. Teoh via Digitalmars-d wrote:
On Sat, Jul 26, 2014 at 07:39:50PM -0700, Andrei Alexandrescu via Digitalmars-d wrote:
On 7/26/14, 6:30 PM, w0rp wrote:
The std.algortihm documentation doesn't look good, and I don't have
any good ideas for it.

I find std.algorithm among the best documented libraries out there! I
must be in denial... -- Andrei

"No, I'm not in denial! It can't be!!!"

Well correction: I think it's among the better documented modules in std. -- Andrei

It's not the text, it's just the current formatting. The cheat sheet can't fit into a smaller column size as a table. So you can break that down into smaller headings and paragraphs instead so it will reflow, but then the length of the page gets bumped up quite a bit and makes it harder to find things at a glance.

Because it's probably the most important library in all of Phobos, it's probably worth excluding the usual output of lists of Functions, Structs, etc. from std.algortihm and letting the cheat sheet itself be the list of symbols, which is organised a lot better than a sort by symbol type then name will ever be. I like the "these are for iteration" kind of categorisation. I'd probably then remove the table right at the top, so you have the module description and example above the fold.

That's what I'm thinking at the moment anyway.

Reply via email to