[jira] [Work logged] (AVRO-3159) Error in AVRO specification

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/AVRO-3159?focusedWorklogId=777984&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-777984 ]

ASF GitHub Bot logged work on AVRO-3159:
----------------------------------------

                Author: ASF GitHub Bot
            Created on: 03/Jun/22 09:00
            Start Date: 03/Jun/22 09:00
    Worklog Time Spent: 10m 
      Work Description: opwvhk opened a new pull request, #1709:
URL: https://github.com/apache/avro/pull/1709

   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [X] My PR addresses the following [Avro Jira](https://issues.apache.org/jira/browse/AVRO/) issues and references them in the PR title. For example, "AVRO-1234: My Avro PR"
     - https://issues.apache.org/jira/browse/AVRO-3159
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Tests
   
   - [X] My PR ~adds the following unit tests __OR__~ does not need testing for this extremely good reason: it clarifies existing documentation
   
   ### Commits
   
   - [X] My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](https://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [X] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain Javadoc that explain what it does
   




Issue Time Tracking
-------------------

            Worklog Id:     (was: 777984)
    Remaining Estimate: 0h
            Time Spent: 10m

> Error in AVRO specification
> ---------------------------
>
>                 Key: AVRO-3159
>                 URL: https://issues.apache.org/jira/browse/AVRO-3159
>             Project: Apache Avro
>          Issue Type: Bug
>          Components: doc
>            Reporter: Dave Cole
>            Assignee: Ryan Skraba
>            Priority: Minor
>             Fix For: 1.11.1
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> On [http://avro.apache.org/docs/current/spec.html#binary_encode_primitive] the example given for encoding Unions appears to have an error:
> {quote}For example, the union schema ["null","string"] would encode:
> null as zero (the index of "null" in the union):
> 00
> the string "a" as one (the index of "string" in the union, encoded as hex 02), followed by the serialized string:
> 02 02 61
> {quote}
> Surely the "string" in the union is encoded as hex 01...  It is defined as "the zero-based position within the union of the schema".  The list has only two entries, so 02 is not a valid index.



--
This message was sent by Atlassian Jira
(v8.20.7#820007)