groovy-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Suderman Keith <keisuder...@vassar.edu>
Subject Re: [GitHub] groovy pull request: Link to MrHaki's blog in TupleConstructor jav...
Date Fri, 26 Feb 2016 17:36:21 GMT
I side with Cédric here.  The Java/Groovy docs should only link to other parts of the official
documentation, or at least to endpoints the Groovy team controls.  I don’t have to go online
to read the docs or root around in my ~/.m2 repo to find them, they are displayed automagically
by my IDE and should never contain broken links.

I strongly suspect that if someone on the Groovy team were to reach out to Mr Haki (Hubert)
that he would allow snippets of his blog posts to be included in the official documentation.

> On Feb 26, 2016, at 3:22 AM, Jesper Steen Møller <jesper@selskabet.org> wrote:
> 
> Also, people these days would usually consult documentation online sources than bother
with locating any local javadoc/groovydoc documentation sources, hidden away in some local
m2 repo cache (or is that just me?). That’d make a stale link somewhat less likely, outweighed
by the goodness of Groovy Goodness.
> 
> -Jesper
> 
>> On 26. feb. 2016, at 08.35, Peter Ledbrook <peter@cacoethes.co.uk <mailto:peter@cacoethes.co.uk>>
wrote:
>> 
>> On Wed, 24 Feb 2016 at 16:30 Cédric Champeau <cedric.champeau@gmail.com <mailto:cedric.champeau@gmail.com>>
wrote:
>> I don't think linking to external resources like this is a good idea. We don't own
the end link, it can be dead very easily, especially in the future. I would rather improve
the documentation.
>> 
>> While I understand the concern, I think this is just one of the risks of the internet.
The docs already have links to the Java API docs, perhaps RFCs and other resources. Although
you may have more confidence in those staying where they are, they may break in future.
>> 
>> This is more about helping users in the short and medium term, in recognition that
bulking out the javadocs themselves isn't likely to happen at a fast pace. And I'm sure it's
possible to run checks over the generated javadocs to ensure that all links are valid. In
fact, I'd argue that should be in place already. Then we'd have some protection against any
sudden unavailability of Groovy Goodness.
>> 
>> Peter
>> 
>> --
>> Peter Ledbrook
>> t: @pledbrook
>> w: http://www.cacoethes.co.uk/ <http://www.cacoethes.co.uk/>
> 


Mime
View raw message