[
https://issues.apache.org/jira/browse/AVRO-2019?focusedWorklogId=685428&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-685428
]
ASF GitHub Bot logged work on AVRO-2019:
----------------------------------------
Author: ASF GitHub Bot
Created on: 23/Nov/21 17:12
Start Date: 23/Nov/21 17:12
Worklog Time Spent: 10m
Work Description: opwvhk opened a new pull request #1413:
URL: https://github.com/apache/avro/pull/1413
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-2019
- ~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: documentation change
### 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
--
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: dev-unsubscr...@avro.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 685428)
Remaining Estimate: 0h
Time Spent: 10m
> Improve documentation for logical type annotations in IDL
> ---------------------------------------------------------
>
> Key: AVRO-2019
> URL: https://issues.apache.org/jira/browse/AVRO-2019
> Project: Apache Avro
> Issue Type: Improvement
> Components: doc, logical types
> Reporter: Andrew Rosca
> Assignee: Andrew Rosca
> Priority: Minor
> Labels: pull-request-available
> Attachments: AVRO-2019.patch
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> The IDL documentation lacks information for how annotations can be specified
> for logical types, like in the following example:
> {code}
> protocol test {
> record test {
> @logicalType("timestamp-millis")
> long time;
> }
> }
> {code}
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
