[
https://issues.apache.org/jira/browse/LUCENE-10148?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17424503#comment-17424503
]
Robert Muir commented on LUCENE-10148:
--------------------------------------
updated patch. I agree it is better with some "inlined" info to the
RandomAccessInput. it {{@see}}'d the relevant relative read methods from
{{DataInput}} already, but its better to not make someone click around to
figure it all out.
> Fix DataInput/Output javadocs, MIGRATE.txt to document endianness
> -----------------------------------------------------------------
>
> Key: LUCENE-10148
> URL: https://issues.apache.org/jira/browse/LUCENE-10148
> Project: Lucene - Core
> Issue Type: Task
> Affects Versions: main (9.0)
> Reporter: Robert Muir
> Priority: Major
> Attachments: LUCENE-10148.patch, LUCENE-10148.patch
>
>
> Currently docs look like this:
> {code}
> /**
> * Reads two bytes and returns a short.
> */
> public short readShort() throws IOException;
> {code}
> Let's improve them with more content, something like this at a minimum:
> {code}
> /**
> * Reads two bytes and returns a short (LE byte order).
> *
> * @see BitUtil#VH_LE_SHORT
> */
> public short readShort() throws IOException;
> {code}
> Also, because these methods were defined previously in Lucene 8.x versions to
> be big-endian, but are now little-endian, we should add a blurb to MIGRATE.md
> to call this change out better, to reduce surprises:
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
