How about simply:
/** Expert:
*
* If set, omit term freq, positions and payloads from postings for this field.
*
* <p><b>NOTE</b>: While this option reduces storage space required in
the index,
* it also means any query requiring positional
* information, such as {...@link PhraseQuery} or {...@link
* SpanQuery} subclasses will silently fail to find
* results.
*/
Mike
On Wed, Apr 8, 2009 at 8:30 AM, Mark Miller <markrmil...@gmail.com> wrote:
> The omitTf comment is:
>
> /** Expert:
> *
> * If set, omit term freq, positions and payloads from postings for this
> field.
> * <p><b>NOTE</b>: this is a dangerous option to enable.
> * While it reduces storage space required in the index,
> * it also means any query requiring positional
> * infromation, such as {...@link PhraseQuery} or {...@link
> * SpanQuery} subclasses will silently fail to find
> * results.
> */
> void setOmitTermFreqAndPositions(boolean omitTermFreqAndPositions);
>
> I'd almost like to factor 'danerous' into something a little less
> oft-putting for a newer or less hardcore user. I know we have this marked as
> expert, but common, decent, advice might be to set each of your fields to
> use as little as necessary - often that will mean using this setting.
>
> How about:
>
> /** Expert:
> *
> * If set, omit term freq, positions and payloads from postings for this
> field.
> * <p><b>NOTE</b>: if you choose to use this expert option, you should
> * be sure you are familiar with the following:
> * While it reduces storage space required in the index,
> * it also means any query requiring positional
> * infromation, such as {...@link PhraseQuery} or {...@link
> * SpanQuery} subclasses will silently fail to find
> * results.
> */
> void setOmitTermFreqAndPositions(boolean omitTermFreqAndPositions);
>
> Kind of nit picky I know.
>
> --
> - Mark
>
> http://www.lucidimagination.com
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscr...@lucene.apache.org
> For additional commands, e-mail: java-dev-h...@lucene.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: java-dev-h...@lucene.apache.org
