www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - Update vibe.d Phobos documentation?

reply "Rob T" <alanb ucora.com> writes:
I use this experimental sample website regularly for Phobos 
documentation because it's organized much better than what is on 
the official website.

Example:
http://vibed.org/temp/d-programming-language.org/phobos/std/array.html

Of course it's better to have the official website directly host 
an improved format, but I don't know if that's a huge undertaking 
or not, so in the meantime
I'd rather not wait for something like it to materialize in here 
because I have real work to do and it's a productivity booster, 
so is it possible to have the vibe.d website updated to the 
latest documentation? It'll be appreciated greatly if this can be 
done, thanks!


--rt
Feb 20 2013
parent reply =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 20.02.2013 18:45, schrieb Rob T:

 I use this experimental sample website regularly for Phobos
 documentation because it's organized much better than what is on the
 official website.
 
 Example:
 http://vibed.org/temp/d-programming-language.org/phobos/std/array.html
 
 Of course it's better to have the official website directly host an
 improved format, but I don't know if that's a huge undertaking or not,
 so in the meantime
 I'd rather not wait for something like it to materialize in here because
 I have real work to do and it's a productivity booster, so is it
 possible to have the vibe.d website updated to the latest documentation?
 It'll be appreciated greatly if this can be done, thanks!
 


I've updated the docs now. There is also a pull request to start getting
them on dlang.org
<https://github.com/D-Programming-Language/d-programming-language.org/pull/267>.
Feb 20 2013
next sibling parent "Rob T" <alanb ucora.com> writes:
On Wednesday, 20 February 2013 at 22:14:16 UTC, Sönke Ludwig 
wrote:

 Am 20.02.2013 18:45, schrieb Rob T:

 I use this experimental sample website regularly for Phobos
 documentation because it's organized much better than what is 
 on the
 official website.
 
 Example:
 http://vibed.org/temp/d-programming-language.org/phobos/std/array.html
 
 Of course it's better to have the official website directly 
 host an
 improved format, but I don't know if that's a huge undertaking 
 or not,
 so in the meantime
 I'd rather not wait for something like it to materialize in 
 here because
 I have real work to do and it's a productivity booster, so is 
 it
 possible to have the vibe.d website updated to the latest 
 documentation?
 It'll be appreciated greatly if this can be done, thanks!
 


 I've updated the docs now. There is also a pull request to 
 start getting
 them on dlang.org
 <https://github.com/D-Programming-Language/d-programming-language.org/pull/267>.


Hey, that was quick, thanks a bunch! :)

--rt
Feb 20 2013
prev sibling parent reply Robert <jfanatiker gmx.at> writes:
On Wed, 2013-02-20 at 23:13 +0100, Sönke Ludwig wrote:

 Am 20.02.2013 18:45, schrieb Rob T:

 I use this experimental sample website regularly for Phobos
 documentation because it's organized much better than what is on the
 official website.
 
 Example:
 http://vibed.org/temp/d-programming-language.org/phobos/std/array.html




Hmm. While I really like the layout, because it is so much more readable
then the dlang.org version, I wonder how I get information about members
of a class, e.g. for RedBlackTree:

http://vibed.org/temp/d-programming-language.org/phobos/std/container/RedBlackTree.html

I only get the creator functions. Funnily the link in functions to
redBlackTree leads to a 'page not found'. It also seems that DList has
no members?

Best regards,

Robert
Feb 21 2013
parent reply =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 21.02.2013 17:02, schrieb Robert:

 On Wed, 2013-02-20 at 23:13 +0100, Sönke Ludwig wrote:

 Am 20.02.2013 18:45, schrieb Rob T:

 I use this experimental sample website regularly for Phobos
 documentation because it's organized much better than what is on the
 official website.

 Example:
 http://vibed.org/temp/d-programming-language.org/phobos/std/array.html




 
 Hmm. While I really like the layout, because it is so much more readable
 then the dlang.org version, I wonder how I get information about members
 of a class, e.g. for RedBlackTree:
 
 http://vibed.org/temp/d-programming-language.org/phobos/std/container/RedBlackTree.html
 
 I only get the creator functions. Funnily the link in functions to
 redBlackTree leads to a 'page not found'. It also seems that DList has
 no members?
 
 Best regards,
 
 Robert
 


Oh sorry, the problem is that I generated the docs on Windows and the
two files differ just by the case of the first character - so one was
overwritten by the other. I'll regenerate them on Linux when I have some
time.
Feb 21 2013
next sibling parent reply =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 21.02.2013 18:17, schrieb Sönke Ludwig:

 Am 21.02.2013 17:02, schrieb Robert:

 On Wed, 2013-02-20 at 23:13 +0100, Sönke Ludwig wrote:

 Am 20.02.2013 18:45, schrieb Rob T:

 I use this experimental sample website regularly for Phobos
 documentation because it's organized much better than what is on the
 official website.

 Example:
 http://vibed.org/temp/d-programming-language.org/phobos/std/array.html




 Hmm. While I really like the layout, because it is so much more readable
 then the dlang.org version, I wonder how I get information about members
 of a class, e.g. for RedBlackTree:

 http://vibed.org/temp/d-programming-language.org/phobos/std/container/RedBlackTree.html

 I only get the creator functions. Funnily the link in functions to
 redBlackTree leads to a 'page not found'. It also seems that DList has
 no members?

 Best regards,

 Robert


 
 Oh sorry, the problem is that I generated the docs on Windows and the
 two files differ just by the case of the first character - so one was
 overwritten by the other. I'll regenerate them on Linux when I have some
 time.
 


Done.
Feb 22 2013
parent reply "Steven Schveighoffer" <schveiguy yahoo.com> writes:
On Fri, 22 Feb 2013 13:17:06 -0500, S=C3=B6nke Ludwig  =

<sludwig outerproduct.org> wrote:


 Am 21.02.2013 18:17, schrieb S=C3=B6nke Ludwig:



 Oh sorry, the problem is that I generated the docs on Windows and the=





 two files differ just by the case of the first character - so one was=





 overwritten by the other. I'll regenerate them on Linux when I have s=




ome

 time.


 Done.


Still doesn't look right.  RedBlackTree is listed as a template, but no =
 =

methods or fields are listed.

BTW, I really like this format.  I think once these issues are ironed ou=
t,  =

it should be moved to Phobos docs.

-Steve
Feb 22 2013
parent reply =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 22.02.2013 20:34, schrieb Steven Schveighoffer:

 On Fri, 22 Feb 2013 13:17:06 -0500, Sönke Ludwig
 <sludwig outerproduct.org> wrote:
 

 Am 21.02.2013 18:17, schrieb Sönke Ludwig:


 

 Oh sorry, the problem is that I generated the docs on Windows and the
 two files differ just by the case of the first character - so one was
 overwritten by the other. I'll regenerate them on Linux when I have some
 time.


 Done.


 
 Still doesn't look right.  RedBlackTree is listed as a template, but no
 methods or fields are listed.
 
 BTW, I really like this format.  I think once these issues are ironed
 out, it should be moved to Phobos docs.
 
 -Steve


Fixed.

I think it would be a good idea to put the new documentation into a kind
of half-official place next to the classical docs until they are deemed
error-free. That way the exposure would be higher, so that the remaining
bugs can be found faster.
Feb 23 2013
next sibling parent Robert <jfanatiker gmx.at> writes:
On Sat, 2013-02-23 at 11:55 +0100, Sönke Ludwig wrote:

 Fixed.


http://vibed.org/temp/d-programming-language.org/phobos/std/container/RedBlackTree.html

I love it! :-) It is just so much more readable! Thanks a lot for your
efforts!
Feb 23 2013
prev sibling parent "Steven Schveighoffer" <schveiguy yahoo.com> writes:
On Sat, 23 Feb 2013 05:55:49 -0500, S=C3=B6nke Ludwig  =

<sludwig outerproduct.org> wrote:


 Am 22.02.2013 20:34, schrieb Steven Schveighoffer:

 On Fri, 22 Feb 2013 13:17:06 -0500, S=C3=B6nke Ludwig
 <sludwig outerproduct.org> wrote:


 Am 21.02.2013 18:17, schrieb S=C3=B6nke Ludwig:



 Oh sorry, the problem is that I generated the docs on Windows and t=








he

 two files differ just by the case of the first character - so one w=








as

 overwritten by the other. I'll regenerate them on Linux when I have=








  =


 some
 time.


 Done.


 Still doesn't look right.  RedBlackTree is listed as a template, but =




no

 methods or fields are listed.

 BTW, I really like this format.  I think once these issues are ironed=





 out, it should be moved to Phobos docs.

 -Steve


 Fixed.


Beautiful!

Now, I need to examine how you do this, 'cause I want to do it for my  =

project :)


 I think it would be a good idea to put the new documentation into a ki=


nd

 of half-official place next to the classical docs until they are deeme=


d

 error-free. That way the exposure would be higher, so that the remaini=


ng

 bugs can be found faster.


Yes, I would prefer that.

One further thing I would like to see, even if it's optional, is to see =
 =

types and functions in the tree on the left.

I love that inherited members are documented!  This is exactly what I ha=
ve  =

been looking for for YEARS, and it looks so good/official!

One thing that will need to be addressed/considered before this is  =

accepted as the standard docs is any use of 3rd party tools to generate =
 =

the docs.  I noticed you said you use libevent.  Some purists may not li=
ke  =

that...

-Steve
Feb 23 2013
prev sibling parent reply Marco Leise <Marco.Leise gmx.de> writes:
Am Thu, 21 Feb 2013 18:17:26 +0100
schrieb S=C3=B6nke Ludwig <sludwig outerproduct.org>:


 Oh sorry, the problem is that I generated the docs on Windows and the
 two files differ just by the case of the first character - so one was
 overwritten by the other. I'll regenerate them on Linux when I have some
 time.


Actually, theoretically, there is a flag for CreateFile that
makes it use POSIX semantics and allow two names which only
differ in case.

--=20
Marco
Feb 23 2013
parent =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 23.02.2013 10:33, schrieb Marco Leise:

 Am Thu, 21 Feb 2013 18:17:26 +0100
 schrieb Sönke Ludwig <sludwig outerproduct.org>:
 

 Oh sorry, the problem is that I generated the docs on Windows and the
 two files differ just by the case of the first character - so one was
 overwritten by the other. I'll regenerate them on Linux when I have some
 time.


 
 Actually, theoretically, there is a flag for CreateFile that
 makes it use POSIX semantics and allow two names which only
 differ in case.
 


Interesting. I've never noticed that flag before. Unfortunately that
would only work in the win32 back end (as opposed to the default
libevent back end), but maybe that's actually still a viable option,
I'll look into it.
Feb 23 2013