Uploaded image for project: 'Apache Avro'
  1. Apache Avro
  2. AVRO-3567

XML doc of methods of SchemaNormalization link to private method Fingerprint64(byte[])

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Trivial
    • Resolution: Unresolved
    • 1.11.0
    • None
    • csharp, doc
    • None

    Description

      In the Avro.SchemaNormalization class of the Avro C# library, the XML documentation comments of the following methods describe the behaviour by linking to the Fingerprint64(byte[]) method:

      • public static byte[] Fingerprint(string fpName, byte[] data)
                /// <para>If <i>fpName</i> equals the string
                /// <code>"CRC-64-AVRO"</code>, then the result of <see cref="Fingerprint64(byte[])"/> is
                /// returned in little-endian format.
                /// </para>
        
      • public static long ParsingFingerprint64(Schema s)
                /// Returns <see cref="Fingerprint64(byte[])"/> applied to the parsing canonical form of the supplied schema.
        

      The documentation of the Fingerprint64(byte[]) method then says it computes "the 64-bit Rabin Fingerprint (as recommended in the Avro spec)". However, because the Fingerprint64(byte[]) method is private, Microsoft Visual Studio does not readily display this documentation to developers.

      Please change the documentation of the Fingerprint(string, byte[]) and ParsingFingerprint64(Schema) methods to mention "the 64-bit Rabin Fingerprint" directly, instead of linking to the private method. Alternatively, make the method public.

      Attachments

        Activity

          People

            Unassigned Unassigned
            kniemitalo Kalle Niemitalo
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: