Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-10148

Fix DataInput/Output javadocs, MIGRATE.txt to document endianness

Details

    • Task
    • Status: Closed
    • Major
    • Resolution: Fixed
    • 9.0
    • 9.0
    • None
    • None
    • New

    Description

      Currently docs look like this:

        /**
         * Reads two bytes and returns a short.
         */
      public short readShort() throws IOException;
      

      Let's improve them with more content, something like this at a minimum:

        /**
         * Reads two bytes and returns a short (LE byte order).
         *
         * @see BitUtil#VH_LE_SHORT
         */
      public short readShort() throws IOException;
      

      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:

      Attachments

        1. LUCENE-10148.patch
          3 kB
          Robert Muir
        2. LUCENE-10148.patch
          5 kB
          Robert Muir

        Activity

          People

            Unassigned Unassigned
            rcmuir Robert Muir
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment