[jira] [Commented] (JENA-1768) update jena text doc re multi-field documents

["Brian McBride (Jira)" <ji...@apache.org>]

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

Brian McBride commented on JENA-1768:
-------------------------------------

I have attached some modified text for the documentation.

I have dropped the last of the three bullets in issue description, i.e. documenting the limitations on bound values with multiple fields on the grounds this can be the responsibility of the provider of an external index or a custom text doc producer.

I found updating the documentation hard because the text refers to the default behaviour as if it were the only behaviour whereas for me, the extensibility of Jena text is an important feature. That said, the changes I am suggesting are small and I have no ego invested in the words. Please use if they are useful and discard if they are not.

[^text-query.mdtext]

> update jena text doc re multi-field documents
> ---------------------------------------------
>
>                 Key: JENA-1768
>                 URL: https://issues.apache.org/jira/browse/JENA-1768
>             Project: Apache Jena
>          Issue Type: Bug
>          Components: Jena
>    Affects Versions: Jena 3.13.0
>            Reporter: Brian McBride
>            Priority: Minor
>             Fix For: Jena 3.13.1
>
>         Attachments: text-query.mdtext
>
>
> The documentation states that multiple fields in text queries are not supported. That should be amended to say something along this lines of:
> * normally multiple fields in a text query won't have the effect that you might expect because each triple is indexed as a separate document
> * multiple fields in a text query are accepted and may be useful, e.g. where the text index has not been created by the provided Jena text mechanisms but provided by other means
> * an explanation of limitations on the bound values should there be multiple fields in a returned document
> See also JENA-1749.
> As requested, I will suggest text for the documentation change shortly, but I'm happy if you would rather write it yourself.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)