groovy-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Pascal Schumacher <pascalschumac...@gmx.net>
Subject Re: [GitHub] groovy pull request: Link to MrHaki's blog in TupleConstructor jav...
Date Fri, 26 Feb 2016 17:20:56 GMT
Well it's not really hidden, as the groovy/javadoc is published on the 
web and quite high in the google search results (at least for me).

Also you can configure e.g. Eclipse to automatically download sources 
and javadocs for all dependencies, so it's directly visible in the IDE.

Cheers,
Pascal

Am 26.02.2016 um 09:22 schrieb Jesper Steen Møller:
> 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/
>


Mime
View raw message