From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail4-relais-sop.national.inria.fr (mail4-relais-sop.national.inria.fr [192.134.164.105]) by walapai.inria.fr (8.13.6/8.13.6) with ESMTP id pBECFSn8030116 for ; Wed, 14 Dec 2011 13:15:29 +0100 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AjABAByT6E7U4xEKkGdsb2JhbABDhQimICIBAQEBCQkNBxQDIoFyAQEEASNWEAsaAh8HAgJXBieHZgIGpSGSB4EviUSBFgSNDo0zjF0 X-IronPort-AV: E=Sophos;i="4.71,351,1320620400"; d="scan'208";a="123330064" Received: from moutng.kundenserver.de ([212.227.17.10]) by mail4-smtp-sop.national.inria.fr with ESMTP; 14 Dec 2011 13:14:59 +0100 Received: from office1.lan.sumadev.de (dslb-188-097-012-119.pools.arcor-ip.net [188.97.12.119]) by mrelayeu.kundenserver.de (node=mreu1) with ESMTP (Nemesis) id 0LdZry-1QtFWS1W0g-00iCXm; Wed, 14 Dec 2011 13:14:58 +0100 Received: from [192.168.178.11] (546BF816.cm-12-4d.dynamic.ziggo.nl [84.107.248.22]) by office1.lan.sumadev.de (Postfix) with ESMTPSA id 04479C00C7; Wed, 14 Dec 2011 13:14:57 +0100 (CET) From: Gerd Stolpmann To: oliver Cc: Gabriel Scherer , Edgar Friendly , caml-list@inria.fr In-Reply-To: <20111213202253.GC5387@siouxsie> References: <20111213202253.GC5387@siouxsie> Content-Type: text/plain; charset="UTF-8" Date: Wed, 14 Dec 2011 13:14:57 +0100 Message-ID: <1323864897.7750.12.camel@samsung> Mime-Version: 1.0 X-Mailer: Evolution 2.32.2 Content-Transfer-Encoding: 7bit X-Provags-ID: V02:K0:XHaVM9HUYa60CWwuFYciNxSnoYI4E9OulvJ9uOjtLWE 2PdHtmTzgu/CAXpf3PskZuJ/rUt45Fvc4Ki+sZ/XlKmU7FrbM3 VmgQzbgI8ljP498vDSIwFTJCNHDDGs9cgGlvebFpL2cdhIy6gK uFqBtOTTi9VUv7du47Ls0ML7xc9ISXr08pk8AqHNDa45hGKYTs n4f1/zEUwTTYl5ZVxyBCS3EXcRmGwP4p2YPIEtZz4Ak0hdK+/f LTpWK9mZW92pL6G4iIrNj7CucBsfInHCMu21+pDfqUPJQYPGhr ynATkb7uQPvot5+fkm4w0qewX6Po45EVK4+smTijISq2kGOrF+ hbH86A4NUCfX5ZCPZ8f7ePwW96rgceUsiFbKMHsw6 Subject: Re: more ideas (Re: [Caml-list] how could the community help with Oasis-DB;) towards a CPAN for OCaml? Am Dienstag, den 13.12.2011, 21:22 +0100 schrieb oliver: > Hello, > > > I again want to mention R. > > The installation procdure for users is very easy. > What I also like there, is that the documentation > includes references to books, which explain the algorithms > or other background information. > Maybe thats too much of what is needed for OCaml. > > But it's what I do like there. > > Also R-packages necessarily need to be documented, > have a manpage / package description. > > Not sure if this is necessary with OCaml stuff, > because *.mli files are there, and ocamlc -i could > print the interfaces of the modules, if nothing else is there > to rely on. > But maybe these kinds of minimalistic documentation-generation > could be created automatically by the installing tools. > > Nicely printed html-docs for interfaces are very helpful. > > And also nice would be, to have such nicely printed documentation > also available at the server, even before downloading any packages. > So, browsing a package documentation online could be done > before downloading the package. docs.camlcity.org Gerd > > The type system and module system would make it su much superior > to languages like Perl, Python or others. > > It's always a fun to read the interface docs at the OCaml manual, > or that are provided by other OCaml-projects online, compared to > what any other language offers. > > But for some very big libraries a meta_documentation, > something like a mini-tuorial, an overview on how to > easily jump into the usage of big library would make sense to. > > Something like a hierarchical view of how the modules can be used, > because some modules may provide types that are used by other modules. > If it's displayed hierarchically and graphgically, it could save much time > looking at all kinds of modules, which maybe will never be needed. > > Of course I also think that there should be some docs that explain in some words, > what the module and it's function do. > When exploring ocamlgraph some weeks ago, I saw a interface doc, > but it was not obvious what kind of functionality each function offers, > or how to find a function that offered, what I was looking for. > > Via #ocaml I could get hints to the functions I needed, and it then worked > out of the box. But I would not have found it by myself. > So, maybe even some kind of keyword tagging to a provided function > would be fine. > > > Also what I like in the R community, is that there is a journal, > that offers articles on R, but also on statistics. > I know, there are a lot of blogs around OCaml, some company-driven, > some private. > > But the R journal for R is really something that is an eye-catcher. > Downloadable as pdf. So if I want to have it on paper, I can have > high quality doc. > > Current issue of R-journal: > > http://journal.r-project.org/current.html > > There also is the R-Meta-Blogger-Site R-Bloggers: > > http://www.r-bloggers.com/ > > Of course R has a much much bigger community than OCaml. > > But I think, just bringing in some more ideas could make sense here. > > If this makes sense to OCaml / OCaml community or not, > I don't know. But at least I think the R-community is > somehow inspiring. > > Just my 3.3 KiB > > Ciao, > Oliver >