groovy-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jesper Steen Møller <jes...@selskabet.org>
Subject Re: [GitHub] groovy pull request: Link to MrHaki's blog in TupleConstructor jav...
Date Fri, 26 Feb 2016 08:22:58 GMT
<html><head><meta http-equiv="Content-Type" content="text/html charset=utf-8"></head><body
style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;"
class="" dir="auto"><div class="">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.&nbsp;</div><div
class=""><br class=""></div><div class="">-Jesper</div><div
class=""><br class=""><div><blockquote type="cite" class=""><div class="">On
26. feb. 2016, at 08.35, Peter Ledbrook &lt;<a href="mailto:peter@cacoethes.co.uk"
class="">peter@cacoethes.co.uk</a>&gt; wrote:</div><br class="Apple-interchange-newline"><div
class=""><div dir="ltr" class=""><div class="gmail_quote"><div class="GmSign">On
Wed, 24 Feb 2016 at 16:30 Cédric Champeau &lt;<a href="mailto:cedric.champeau@gmail.com"
class="">cedric.champeau@gmail.com</a>&gt; wrote:<br class=""></div><blockquote
class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div
dir="ltr" class="">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.</div></blockquote><div class=""><br class=""></div>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.</div><div
class="gmail_quote"><br class=""></div><div class="gmail_quote">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.</div><div class="gmail_quote"><br class=""></div><div
class="gmail_quote">Peter<br class=""><br class=""><div class="gmail_quote"><div
class="GmSign">--&nbsp;<br class="">Peter Ledbrook<br class="">t: @pledbrook<br
class=""></div></div><div class="">w:&nbsp;<a href="http://www.cacoethes.co.uk/"
target="_blank" class="">http://www.cacoethes.co.uk/</a>&nbsp;</div></div></div>
</div></blockquote></div><br class=""></div></body></html>
Mime
View raw message