rmuir opened a new issue, #12125:
URL: https://github.com/apache/lucene/issues/12125
### Description
Currently Field.java has these docs:
```
/**
* Expert: directly create a field for a document. Most users should use one
of the sugar
* subclasses:
*
* <ul>
* <li>{@link TextField}: {@link Reader} or {@link String} indexed for
full-text search
* <li>{@link StringField}: {@link String} indexed verbatim as a single
token
* <li>{@link IntPoint}: {@code int} indexed for exact/range queries.
* <li>{@link LongPoint}: {@code long} indexed for exact/range queries.
* <li>{@link FloatPoint}: {@code float} indexed for exact/range queries.
* <li>{@link DoublePoint}: {@code double} indexed for exact/range queries.
* <li>{@link SortedDocValuesField}: {@code byte[]} indexed column-wise
for sorting/faceting
* <li>{@link SortedSetDocValuesField}: {@code SortedSet<byte[]>} indexed
column-wise for
* sorting/faceting
* <li>{@link NumericDocValuesField}: {@code long} indexed column-wise for
sorting/faceting
* <li>{@link SortedNumericDocValuesField}: {@code SortedSet<long>}
indexed column-wise for
* sorting/faceting
* <li>{@link StoredField}: Stored-only value for retrieving in summary
results
* </ul>
```
I think it would be better to bring this up-to-date. We can at least replace
`IntPoint`, `LongPoint`, `FloatPoint`, and `DoublePoint` with `IntField`,
`LongField`, `FloatField`, and `DoubleField`.
Each one of these classes also documents/links you to look at more expert
classes (e.g. `IntPoint`, `SortedNumericDocValuesField`, `StoredField`) if you
want expert control.
But it would be better to point the user to these new easier-to-use field
subclasses.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
