Re: New documentation layout

2014-04-01 Thread Wyatt
On Monday, 31 March 2014 at 08:43:14 UTC, Colin Grogan wrote: I made a comment under it, but there seems to be no traffic there. It's still sort of pre-release (and I still feel quite strongly that the embedded comment system is a bad idea in the first place). Is there a thread elsewhere th

New documentation layout

2014-03-31 Thread Colin Grogan
Not sure where to discuss this, but what are peoples thoughts on the new layout for the phobos documentation? Link -> http://dlang.org/library/index.html I made a comment under it, but there seems to be no traffic there. Is there a thread elsewhere that would be more suitable for this? A few

Re: Documentation Layout

2012-03-30 Thread Andrej Mitrovic
On 3/30/12, Marco Leise wrote: > snip Here's another mind-bender: import std.typetuple; Tuple!(int, int) x; // bz It's in std.typecons of all places. I would assume a tuple would be in a module called typetuple, but no.

Re: Documentation Layout

2012-03-30 Thread Marco Leise
Am Wed, 28 Mar 2012 18:40:17 +0200 schrieb "Nathan M. Swan" : > That's pretty cool! I especially like the categories idea; it > reminds me of Apple's documentation for Cocoa. It really helps > you when you are thinking "I need a function which does...". > > NMS Unfortunately the function that

Re: Documentation Layout

2012-03-29 Thread Ary Manzana
On 3/29/12 5:24 PM, foobar wrote: On Thursday, 29 March 2012 at 01:52:28 UTC, James Miller wrote: On 29 March 2012 13:58, Nathan M. Swan wrote: On Wednesday, 28 March 2012 at 22:43:19 UTC, foobar wrote: Have you considered that perhaps the granularity of Phobos modules is too coarse? Perhap

Re: Documentation Layout

2012-03-29 Thread Jacob Carlborg
On 2012-03-29 11:24, foobar wrote: Have you considered that perhaps the granularity of Phobos modules is too coarse? Perhaps the core issue is too many functions are placed in one single file without more consideration of their relation and organization? Regarding the documentation system itsel

Re: Documentation Layout

2012-03-29 Thread foobar
On Wednesday, 28 March 2012 at 23:30:32 UTC, Adam D. Ruppe wrote: On Wednesday, 28 March 2012 at 22:43:19 UTC, foobar wrote: Categories - worst idea ever. I was just trying to copy what std.algorithm does, which is ok by me. Though, my implementation allows multiple categories; it is more of

Re: Documentation Layout

2012-03-29 Thread foobar
On Thursday, 29 March 2012 at 01:52:28 UTC, James Miller wrote: On 29 March 2012 13:58, Nathan M. Swan wrote: On Wednesday, 28 March 2012 at 22:43:19 UTC, foobar wrote: Categories - worst idea ever. What's better: int a; // this is size OR int size; Same thing applies here - code MUST be se

Re: Documentation Layout

2012-03-28 Thread Jakob Ovrum
On Thursday, 29 March 2012 at 05:41:30 UTC, James Miller wrote: On 29 March 2012 18:26, Jakob Ovrum wrote: There is a simple project called cuteDoc (name comes from the old candyDoc theme) which has a demo using the Phobos documentation:    http://robik.github.com/phobos/ Project home page:

Re: Documentation Layout

2012-03-28 Thread James Miller
On 29 March 2012 18:26, Jakob Ovrum wrote: > There is a simple project called cuteDoc (name comes from the old candyDoc > theme) which has a demo using the Phobos documentation: > >    http://robik.github.com/phobos/ > > Project home page: > >    https://github.com/robik/cuteDoc It looks ok, stil

Re: Documentation Layout

2012-03-28 Thread Jakob Ovrum
On Wednesday, 28 March 2012 at 06:20:57 UTC, James Miller wrote: In another thread (http://forum.dlang.org/thread/CAMfGmZsNX3GsOFVyUaCX79E4H8eTBXqDmUJtm41JSzRNtME=r...@mail.gmail.com) I raged about std.container's documentation, then Teoh pointed out that a lot of Phobos documentation needs imp

Re: Documentation Layout

2012-03-28 Thread H. S. Teoh
On Thu, Mar 29, 2012 at 02:52:17PM +1300, James Miller wrote: [...] > Exactly my point. There is a line between "code must be self > documenting" and "I need to read the code to understand what this > does". Self documenting code is more about removing the cognitive > stress of reading code. Actual

Re: Documentation Layout

2012-03-28 Thread James Miller
On 29 March 2012 13:58, Nathan M. Swan wrote: > On Wednesday, 28 March 2012 at 22:43:19 UTC, foobar wrote: >> >> Categories - worst idea ever. >> >> What's better: >> int a; // this is size >> OR >> int size; >> >> Same thing applies here - code MUST be self documenting as much as >> possible. > >

Re: Documentation Layout

2012-03-28 Thread Nathan M. Swan
On Wednesday, 28 March 2012 at 22:43:19 UTC, foobar wrote: Categories - worst idea ever. What's better: int a; // this is size OR int size; Same thing applies here - code MUST be self documenting as much as possible. But categories are still useful, e.g., when you want a function in std.alg

Re: Documentation Layout

2012-03-28 Thread Brad Anderson
On Wed, Mar 28, 2012 at 6:32 PM, Matt Peterson wrote: > On Wednesday, 28 March 2012 at 07:00:58 UTC, Brad Anderson wrote: > >> [...] >> >> I've been trying to generate parsable ddoc output for use in an >> autocomplete for the search box (symbol names + short documentation >> excerpts for context

Re: Documentation Layout

2012-03-28 Thread Matt Peterson
On Wednesday, 28 March 2012 at 07:00:58 UTC, Brad Anderson wrote: [...] I've been trying to generate parsable ddoc output for use in an autocomplete for the search box (symbol names + short documentation excerpts for context). I had some luck but couldn't strip it down to the bare minimum info

Re: Documentation Layout

2012-03-28 Thread Adam D. Ruppe
On Wednesday, 28 March 2012 at 22:43:19 UTC, foobar wrote: Categories - worst idea ever. I was just trying to copy what std.algorithm does, which is ok by me. Though, my implementation allows multiple categories; it is more of a tagging system (which is how my search program works too, it puts

Re: Documentation Layout

2012-03-28 Thread foobar
On Wednesday, 28 March 2012 at 16:40:19 UTC, Nathan M. Swan wrote: On Wednesday, 28 March 2012 at 14:47:53 UTC, Adam D. Ruppe wrote: On Wednesday, 28 March 2012 at 06:20:57 UTC, James Miller wrote: 1. The "Jump To" index. I did a little program called improveddoc that builds nicer tables: ht

Re: Documentation Layout

2012-03-28 Thread Jacob Carlborg
On 2012-03-28 19:34, Ary Manzana wrote: On 3/28/12 2:20 PM, James Miller wrote: Ok, so I'm going to say this: I like the Java documentation. There, I said it. I like it too. http://downloads.dsource.org/projects/descent/ddoc/phobos/ http://downloads.dsource.org/projects/descent/ddoc/tango/ A

Re: Documentation Layout

2012-03-28 Thread Ary Manzana
On 3/28/12 2:20 PM, James Miller wrote: Ok, so I'm going to say this: I like the Java documentation. There, I said it. I like it too. http://downloads.dsource.org/projects/descent/ddoc/phobos/ http://downloads.dsource.org/projects/descent/ddoc/tango/ And cross-references are not hard at all.

Re: Documentation Layout

2012-03-28 Thread Nathan M. Swan
On Wednesday, 28 March 2012 at 14:47:53 UTC, Adam D. Ruppe wrote: On Wednesday, 28 March 2012 at 06:20:57 UTC, James Miller wrote: 1. The "Jump To" index. I did a little program called improveddoc that builds nicer tables: http://arsdnet.net/d-web-site/improveddoc.d makes: http://arsdnet.ne

Re: Documentation Layout

2012-03-28 Thread Adam D. Ruppe
On Wednesday, 28 March 2012 at 06:20:57 UTC, James Miller wrote: 1. The "Jump To" index. I did a little program called improveddoc that builds nicer tables: http://arsdnet.net/d-web-site/improveddoc.d makes: http://arsdnet.net/d-web-site/std_stdio.html It does post-processing on the dom to

Re: Documentation Layout

2012-03-28 Thread Brad Anderson
On Wed, Mar 28, 2012 at 12:20 AM, James Miller wrote: > In another thread > ( > http://forum.dlang.org/thread/CAMfGmZsNX3GsOFVyUaCX79E4H8eTBXqDmUJtm41JSzRNtME=r...@mail.gmail.com > ) > I raged about std.container's documentation, then Teoh pointed out > that a lot of Phobos documentation needs im

Documentation Layout

2012-03-27 Thread James Miller
In another thread (http://forum.dlang.org/thread/CAMfGmZsNX3GsOFVyUaCX79E4H8eTBXqDmUJtm41JSzRNtME=r...@mail.gmail.com) I raged about std.container's documentation, then Teoh pointed out that a lot of Phobos documentation needs improving. While he was talking about content, it got me thinking about