Mailing-List: contact dev-help@groovy.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@groovy.apache.org
MIME-Version: 1.0
In-Reply-To: <1456562901242-5731443.post@n5.nabble.com>
References: 
 <CADQzvmknP1LUd_VLX8ymQtEJdXq5Mm0HzfSdNGMQPzi5+K_GaQ@mail.gmail.com>
	<CANBeYQSUcZ6PHHZLu5GD1nXRpO4j_HXwCtkOhgCSY4=Q_hW+jQ@mail.gmail.com>
	<8BDB9669-7BE0-41B8-A67B-72132661BFFC@selskabet.org>
	<CADQzvmk1APQuJQD6dE+4KghyoX-U3gq=p-VRXjxrW+aBj20r1Q@mail.gmail.com>
	<CAJ2HCd_VHG+xqRH6CXdKvDzEVE4+4TCuGXn9-CupbyHKp1tb+Q@mail.gmail.com>
	<etPan.56d0229a.46c7765a.3226@SBGLASIUS-MBP.local>
	<1456562901242-5731443.post@n5.nabble.com>
Date: Sat, 27 Feb 2016 10:26:56 +0100
Message-ID: 
 <CAF86WpjfYhOAPA0HYD=3xjPY4iumw+944Unh_6ruVU26YenxHA@mail.gmail.com>
Subject: Re: [GitHub] groovy pull request: Link to MrHaki's blog in
 TupleConstructor jav...
From: jim northrop <james.b.northrop@googlemail.com>
To: dev@groovy.apache.org
Content-Type: multipart/alternative; boundary=001a113ec87e5203e3052cbd0439

--001a113ec87e5203e3052cbd0439
Content-Type: text/plain; charset=UTF-8

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.
>

--001a113ec87e5203e3052cbd0439
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div class=3D"gmail_default" style=3D"font-family:georgia,=
serif;color:rgb(7,55,99)">was thinking of the same problem with our <a href=
=3D"http://gpars.website">http://gpars.website</a>. Do we include code samp=
les or not ? or only links to external sites ? i like the idea of &quot;liv=
e&quot; code fragments within the doc.s=C2=A0 that are compiled/tested as a=
 part of document generation. this guarantees that code in our docs works a=
s stated. Users can then cut-n-paste with assurance.<br></div></div><div cl=
ass=3D"gmail_extra"><br><div class=3D"gmail_quote">On 27 February 2016 at 0=
9:48, mrhaki <span dir=3D"ltr">&lt;<a href=3D"mailto:h.kleinikkink@gmail.co=
m" target=3D"_blank">h.kleinikkink@gmail.com</a>&gt;</span> wrote:<br><bloc=
kquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1px #cc=
c solid;padding-left:1ex">I think it is better to have very complete docume=
ntation at GroovyDoc level,<br>
without the need to follow external links.=C2=A0 My experience with the Rat=
pack<br>
Javadoc documentation is that with all example code and snippets included a=
t<br>
Javadoc level that it is very easy to use as reference.<br>
<br>
It is no problem to use the snippets from my blog in the documentation.<br>
<br>
I like Guillaume&#39;s mention that the code could even be tested if it is<=
br>
included in the GroovyDoc, which makes at least sure the code works.<br>
<br>
In the nearby future I certainly want to contribute to adding snippets to<b=
r>
the existing Groovydoc sources.<br>
<br>
Hubert Klein Ikkink &lt;mrhaki&gt;<br>
@mrhaki<br>
<a href=3D"http://www.mrhaki.com" rel=3D"noreferrer" target=3D"_blank">www.=
mrhaki.com</a><br>
<br>
<br>
<br>
<br>
--<br>
View this message in context: <a href=3D"http://groovy.329449.n5.nabble.com=
/Re-GitHub-groovy-pull-request-Link-to-MrHaki-s-blog-in-TupleConstructor-ja=
v-tp5731382p5731443.html" rel=3D"noreferrer" target=3D"_blank">http://groov=
y.329449.n5.nabble.com/Re-GitHub-groovy-pull-request-Link-to-MrHaki-s-blog-=
in-TupleConstructor-jav-tp5731382p5731443.html</a><br>
Sent from the Groovy Dev mailing list archive at Nabble.com.<br>
</blockquote></div><br></div>

--001a113ec87e5203e3052cbd0439--