Re: Data.List documentation improvements
The deadline for this update is up. Can somebody commit the changes for me? Here is the ticket with the patch: http://hackage.haskell.org/trac/ghc/ticket/1034 Andriy ____________________________________________________________________________________ Want to start your own business? Learn how on Yahoo! Small Business. http://smallbusiness.yahoo.com/r-index
Hi,
instead of adding examples to the documentation, wouldn't it be better
to have a wiki site that documents the libraries, and everyone can add
examples there. I am thinking something along the lines of:
http://us2.php.net/manual/en/function.fopen.php
-iavor
PS: I find the darcs patches that are being sent _very_ unreadable:
they contain tons of information that is not at all relevant to the
change that was made. Is there a simpler way to show what was done?
Perhaps a simple diff?
On 12/6/06, Andriy Palamarchuk
The deadline for this update is up. Can somebody commit the changes for me?
Here is the ticket with the patch: http://hackage.haskell.org/trac/ghc/ticket/1034
Andriy
____________________________________________________________________________________ Want to start your own business? Learn how on Yahoo! Small Business. http://smallbusiness.yahoo.com/r-index _______________________________________________ Libraries mailing list Libraries@haskell.org http://www.haskell.org/mailman/listinfo/libraries
On Thu, 2006-12-07 at 09:49 -0800, Iavor Diatchki wrote:
Hi, instead of adding examples to the documentation, wouldn't it be better to have a wiki site that documents the libraries, and everyone can add examples there. I am thinking something along the lines of: http://us2.php.net/manual/en/function.fopen.php
I added a feature to Haddock to link modules/functions to source code and/or to a wiki site (the feature is included in haddock 0.8). So we could make something like this work for the standard set of docs on the ghc site. We'd need to decide on a url scheme and probably find some way of using a standard template or pre-creating the wiki pages (I'd assume we'd have one per module). It's possible to link on a per-function basis to content inside a wiki page if you use a url scheme like: http://haskell.org/haskellwiki/libraries/%module%#%varid% I assume it's possible to make href anchors in a wiki page, though to do it consistently might need more advice from the wiki experts. Duncan
Duncan Coutts wrote:
On Thu, 2006-12-07 at 09:49 -0800, Iavor Diatchki wrote:
Hi, instead of adding examples to the documentation, wouldn't it be better to have a wiki site that documents the libraries, and everyone can add examples there. I am thinking something along the lines of: http://us2.php.net/manual/en/function.fopen.php
I added a feature to Haddock to link modules/functions to source code and/or to a wiki site (the feature is included in haddock 0.8). So we could make something like this work for the standard set of docs on the ghc site.
We'd need to decide on a url scheme and probably find some way of using a standard template or pre-creating the wiki pages (I'd assume we'd have one per module).
This sound like a good idea to me, but please make sure that links to non-existing (or empty) wiki pages are marked (by color or whatever). This is usually done in wikis so that the reader is spared the frustration of clicking on dead links... Cheers Ben
On Fri, 2006-12-08 at 00:46 +0100, Benjamin Franksen wrote:
Duncan Coutts wrote:
I added a feature to Haddock to link modules/functions to source code and/or to a wiki site (the feature is included in haddock 0.8). So we could make something like this work for the standard set of docs on the ghc site.
We'd need to decide on a url scheme and probably find some way of using a standard template or pre-creating the wiki pages (I'd assume we'd have one per module).
This sound like a good idea to me, but please make sure that links to non-existing (or empty) wiki pages are marked (by color or whatever). This is usually done in wikis so that the reader is spared the frustration of clicking on dead links...
There's no way to do this as far as I know. The haddock docs are static and not part of the wiki so there's no easy way to generate different link content based on whether the target page exists or not. Any idea how it could be done? Duncan
Hi
There's no way to do this as far as I know. The haddock docs are static and not part of the wiki so there's no easy way to generate different link content based on whether the target page exists or not.
Any idea how it could be done?
A bit of AJAX should be able to do this, as long as the documentation and the wiki are on the same domain. I can provide some code that does this if anyone needs it. Thanks Neil
duncan.coutts:
On Thu, 2006-12-07 at 09:49 -0800, Iavor Diatchki wrote:
Hi, instead of adding examples to the documentation, wouldn't it be better to have a wiki site that documents the libraries, and everyone can add examples there. I am thinking something along the lines of: http://us2.php.net/manual/en/function.fopen.php
I added a feature to Haddock to link modules/functions to source code and/or to a wiki site (the feature is included in haddock 0.8). So we could make something like this work for the standard set of docs on the ghc site.
We'd need to decide on a url scheme and probably find some way of using a standard template or pre-creating the wiki pages (I'd assume we'd have one per module). It's possible to link on a per-function basis to content inside a wiki page if you use a url scheme like:
http://haskell.org/haskellwiki/libraries/%module%#%varid%
I assume it's possible to make href anchors in a wiki page, though to do it consistently might need more advice from the wiki experts.
Yes, this is a great idea. a [wiki] or some such link for haddock docs in standard libraries taking us to pages to be filled out with examples and recipes. -- Don
participants (6)
-
Andriy Palamarchuk -
Benjamin Franksen -
dons＠cse.unsw.edu.au -
Duncan Coutts -
Iavor Diatchki -
Neil Mitchell