groovy-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Pascal Schumacher <pascalschumac...@gmx.net>
Subject Re: groovy.sql Documentation and the doco process
Date Tue, 07 Jul 2015 18:27:08 GMT
Great. :) I just merged the pull request. Thanks a lot!

Am 07.07.2015 um 19:33 schrieb Keegan Witt:
> Okie dokie.  Here's the PR: 
> https://github.com/apache/incubator-groovy/pull/57 By the way, I 
> actually found some more public ones that needed fixed.
>
> On Tue, Jul 7, 2015 at 11:41 AM, Pascal Schumacher 
> <pascalschumacher@gmx.net <mailto:pascalschumacher@gmx.net>> wrote:
>
>     Well if it's not public, then it's no critical imho. If you like
>     to create a pull request, we'll merge.
>
>
>     Am 07.07.2015 um 16:06 schrieb Keegan Witt:
>>     By the way, there are other places that have this problem, but
>>     are not public (for example MetaClassImpl.filterPropertyMethod).
>>     Do you want to fix these as well?  Obviously the Javadoc tool
>>     won't create documentation for these by default, but one could
>>     use the -private argument to include those.
>>
>>     On Tue, Jul 7, 2015 at 9:48 AM, Keegan Witt <keeganwitt@gmail.com
>>     <mailto:keeganwitt@gmail.com>> wrote:
>>
>>         I went ahead and created one:
>>         https://github.com/apache/incubator-groovy/pull/56
>>
>>         On Tue, Jul 7, 2015 at 8:42 AM, Keegan Witt
>>         <keeganwitt@gmail.com <mailto:keeganwitt@gmail.com>> wrote:
>>
>>             I'm seeing the same thing.  The last thing on this page
>>             (http://docs.groovy-lang.org/latest/html/gapi/groovy/sql/Sql.html)
>>             is "Several of the methods in this class (ones which have
>>             a String-based sql query and params in a List".
>>
>>             This is because there is unescaped < and > in the Javadoc:
>>
>>             Several of the methods in this class (ones which have a
>>             String-based sql query and params in * a List<Object> or
>>             Object[] or Map)
>>
>>             and I'm running Firefox with the FlashBlock extension.  I
>>             can create a PR to correct if you like.
>>
>>             -Keegan
>>
>>
>>             On Tue, Jul 7, 2015 at 6:26 AM, Paul King
>>             <paulk@asert.com.au <mailto:paulk@asert.com.au>> wrote:
>>
>>
>>                 Can you confirm the link you are using? Also which
>>                 browser/os are you using? The link you gave in your
>>                 earlier message looks okay to me.
>>
>>                 Cheers, Paul.
>>
>>                 On 7/07/2015 10:09 AM, Eric MacAdie wrote:
>>
>>                     Here are the last two parts (one of which is a
>>                     header):
>>
>>
>>                             Named and named ordinal parameters
>>
>>                     Several of the methods in this class (ones which
>>                     have a String-based sql query and params in a List
>>
>>                     = Eric MacAdie
>>
>>                     On Mon, Jul 6, 2015 at 11:33 AM, Pascal
>>                     Schumacher <pascalschumacher@gmx.net
>>                     <mailto:pascalschumacher@gmx.net>
>>                     <mailto:pascalschumacher@gmx.net
>>                     <mailto:pascalschumacher@gmx.net>>> wrote:
>>
>>                         Hi Eric,
>>
>>                         thanks for the info. :)
>>
>>                         Which sentence are you referencing to?
>>
>>                         Cheers,
>>                         Pascal
>>
>>
>>                         Am 06.07.2015 um 04:45 schrieb Eric MacAdie:
>>
>>                             Also, the javadoc for groovy.sql.Sql
>>                         seems to be cutoff midsentence:
>>                         http://docs.groovy-lang.org/latest/html/gapi/groovy/sql/Sql.html
>>
>>                             = Eric MacAdie
>>
>>
>>                             On Sun, Jul 5, 2015 at 4:52 PM, Duncan
>>                         Dickinson <me@duncan.dickinson.name
>>                         <mailto:me@duncan.dickinson.name>
>>                         <mailto:me@duncan.dickinson.name
>>                         <mailto:me@duncan.dickinson.name>>> wrote:
>>
>>                                 Hi All,
>>
>>                                 I noticed that the "Working with a
>>                         relational database" section of the
>>                         documentation is empty:
>>                         <http://docs.groovy-lang.org/latest/html/documentation/databases.html>http://docs.groovy-lang.org/latest/html/documentation/databases.html
>>                         . However there does appear to be doco in
>>                         <https://github.com/groovy/groovy-core/blob/master/subprojects/groovy-sql/src/spec/doc/sql-userguide.adoc>https://github.com/groovy/groovy-core/blob/master/subprojects/groovy-sql/src/spec/doc/sql-userguide.adoc
>>                         - is this something just awaiting the next
>>                         website refresh?
>>
>>                                 I was thinking that I could add to
>>                         the documentation so read up on Peter L's
>>                         how-to blog post. It all looks straight
>>                         forward but I'm keen not to start something
>>                         that's already being worked on - hence this
>>                         email to check status.
>>
>>                                 Lastly, there doesn't appear to be a
>>                         process around co-ordinating documentation
>>                         aside from people tagging the document
>>                         they're working on. I was wondering if the
>>                         Jira "Documentation" component* couldn't be
>>                         used to a greater extent. Essentially we'd
>>                         likely have 2 types of tickets - a bug for
>>                         errors/typos/etc and a task for new/modifying
>>                         doco. Perhaps a Lead for the component may
>>                         also be useful.
>>
>>                                 This would mean that people could
>>                         allocate themsleves a ticket and keep it
>>                         updated to let people know that it's actively
>>                         being worked on.
>>
>>                                 Lastly, I assume that the Apache 2
>>                         licence covers the documentation...
>>
>>                                 *
>>                         https://issues.apache.org/jira/browse/GROOVY/component/12326646/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
>>
>>                                 Cheers,
>>
>>                                 Duncan
>>
>>
>>
>>
>>
>>
>>                 ---
>>                 This email has been checked for viruses by Avast
>>                 antivirus software.
>>                 https://www.avast.com/antivirus
>>
>>
>>
>>
>
>


Mime
View raw message