groovy-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jim northrop <james.b.north...@googlemail.com>
Subject Re: [GitHub] groovy pull request: Link to MrHaki's blog in TupleConstructor jav...
Date Sat, 27 Feb 2016 09:26:56 GMT
was thinking of the same problem with our http://gpars.website. Do we
include code samples or not ? or only links to external sites ? i like the
idea of "live" code fragments within the doc.s  that are compiled/tested as
a part of document generation. this guarantees that code in our docs works
as stated. Users can then cut-n-paste with assurance.

On 27 February 2016 at 09:48, mrhaki <h.kleinikkink@gmail.com> wrote:

> I think it is better to have very complete documentation at GroovyDoc
> level,
> without the need to follow external links.  My experience with the Ratpack
> Javadoc documentation is that with all example code and snippets included
> at
> Javadoc level that it is very easy to use as reference.
>
> It is no problem to use the snippets from my blog in the documentation.
>
> I like Guillaume's mention that the code could even be tested if it is
> included in the GroovyDoc, which makes at least sure the code works.
>
> In the nearby future I certainly want to contribute to adding snippets to
> the existing Groovydoc sources.
>
> Hubert Klein Ikkink <mrhaki>
> @mrhaki
> www.mrhaki.com
>
>
>
>
> --
> View this message in context:
> http://groovy.329449.n5.nabble.com/Re-GitHub-groovy-pull-request-Link-to-MrHaki-s-blog-in-TupleConstructor-jav-tp5731382p5731443.html
> Sent from the Groovy Dev mailing list archive at Nabble.com.
>

Mime
View raw message