Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Field.java documentation to refer to new IntField/FloatField/LongField/DoubleField #12125

Closed
rmuir opened this issue Feb 2, 2023 · 1 comment

Comments

@rmuir
Copy link
Member

rmuir commented Feb 2, 2023

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.

@rmuir rmuir added the type:task label Feb 2, 2023
@Harshitha-g-06
Copy link

@rmuir Hi, may I work on this task?

Harshitha-g-06 added a commit to SreehariG73/lucene that referenced this issue Nov 17, 2023
SreehariG73 added a commit to SreehariG73/lucene that referenced this issue Nov 17, 2023
Fix Field.java documentation to refer to new IntField/FloatField/LongField/DoubleField apache#12125
SreehariG73 pushed a commit to SreehariG73/lucene that referenced this issue Jan 15, 2024
jpountz pushed a commit that referenced this issue Jan 15, 2024
slow-J pushed a commit to slow-J/lucene that referenced this issue Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants