http://d.puremagic.com/issues/show_bug.cgi?id=9370
Knud <k...@all-technology.com> changed:
What |Removed |Added
----------------------------------------------------------------------------
CC| |k...@all-technology.com
--- Comment #4 from Knud <k...@all-technology.com> 2013-01-28 14:00:02 PST ---
>From http://forum.dlang.org/post/kdl45o$30ak$1...@digitalmars.com
== online documentation ==
When I returned to D I felt very frustrated with D online documentation.
After looking for root of the feeling i found that the reason was that
I was used to the documentation of php.
In php each function have a page of it own. (Closely resembling the unix
man page)
This means that if I search for "php strip" google send me to
http://php.net/manual/en/function.trim.php
Where the first line tells me:
trim — Strip whitespace (or other characters) from the beginning and end
of a string
So It is very fast to see if I got the right page.
If I search for "dlang strip" I am send to
http://dlang.org/phobos/std_string.html.
Then I have to look through the document to find the right function
and to find that functions typical is missing examples and good
descriptions of parameters and return values.
(I think that the example part can be improved by automatic including
unittest in the documentation,
which would also insure that the examples is working.)
(When documents is generated ddoc could test for if description for
parameters and return values was present)
Also another thing I like about the php documentation is the user notes
at the bottom of the page,
I know you are trying to make something simmilar with the "Improve this
page" and "Page wiki" at the top,
but I have to say that I don't think it works as well.
--
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
