siddheshbandgar opened a new pull request, #16642:
URL: https://github.com/apache/lucene/pull/16642
Related to #15225
This PR expands the sparse, one-line package description of
`org.apache.lucene.store` into concise documentation that explains the
package's purpose and key abstractions (Directory, IndexInput/IndexOutput,
DataInput/DataOutput, ChecksumIndexInput, Lock/LockFactory, and common
Directory implementations).
What was changed:
- Rewrote `lucene/core/src/java/org/apache/lucene/store/package-info.java`
with pointed, human-first documentation covering:
- The role of the store package as the binary I/O layer for all index data
- The `Directory` abstraction and common implementations (`FSDirectory`,
`MMapDirectory`, `ByteBuffersDirectory`, `FilterDirectory`,
`TrackingDirectoryWrapper`)
- Reading/writing via `IndexInput`/`IndexOutput` and their
`DataInput`/`DataOutput` primitives
- Checksum verification via `ChecksumIndexInput`
- Locking and consistency through `Lock`/`LockFactory`
I deliberately kept it concise rather than verbose. If any wording needs
adjustment to match Lucene's documentation style, I'm happy to revise.
cc @jainankitk for review
--
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]
