[ 
https://issues.apache.org/jira/browse/JENA-1755?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16927652#comment-16927652
 ] 

Claude Warren commented on JENA-1755:
-------------------------------------

I became aware of this issue during the discussion of JENA-1751 which I then 
used in my talk at ApacheCon when I was discussing the difficulty in finding 
documentation.  I am very interested in helping to sort out this issue and will 
both author and review documentation.  We may need to revisit how we distribute 
the documentation across the site.  But I think that can wait until we get the 
documentation for Query builder in good shape.

> Improve documentation of Query Builders
> ---------------------------------------
>
>                 Key: JENA-1755
>                 URL: https://issues.apache.org/jira/browse/JENA-1755
>             Project: Apache Jena
>          Issue Type: Improvement
>            Reporter: Jan Martin Keil
>            Priority: Major
>
> As discussed in JENA-1751, I propose to improve the documentation of the 
> query builders:
> {quote}Unfortunately, I did not find (and I think there isn't) any 
> documentation or tutorial about the query builders explaining more than the 
> very basics. Also the JavaDoc (which is to the best of my knowledge nowhere 
> linked on [https://jena.apache.org/]), is, in my experience, not helpful and 
> makes it often necessary to look into the code to understand what is needed 
> and maybe find out how to get it. If I did not miss a comprehensive 
> documentation somewhere, I think it would be worth, to improve documentation. 
> Even a few words at the builder classes (mentioning e.g. ExprFactory) and 
> small examples at the more complicated methods would help a lot.
> {quote}



--
This message was sent by Atlassian Jira
(v8.3.2#803003)

Reply via email to