You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by GitBox <gi...@apache.org> on 2021/11/23 17:12:20 UTC
[GitHub] [avro] opwvhk opened a new pull request #1413: AVRO-2019: Improve docs for logical type annotation
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-unsubscribe@avro.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [avro] RyanSkraba commented on a change in pull request #1413: AVRO-2019: Improve docs for logical type annotation
Posted by GitBox <gi...@apache.org>.
RyanSkraba commented on a change in pull request #1413:
URL: https://github.com/apache/avro/pull/1413#discussion_r767262400
##########
File path: doc/src/content/xdocs/idl.xml
##########
@@ -252,6 +252,14 @@ record Job {
time_ms submitTime;
timestamp_ms finishTime;
decimal(9,2) finishRatio;
+}
+ </source>
+ <p>Logical types can also be specified via an annotation, which is useful for logical types for which a keyword does not exist:</p>
+ <source>
+record Job {
+ string jobid;
+ @logicalType("timestamp-micros")
+ long finishTime;
Review comment:
Thanks @martin-g !
--
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: issues-unsubscribe@avro.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [avro] opwvhk commented on pull request #1413: AVRO-2019: Improve docs for logical type annotation
Posted by GitBox <gi...@apache.org>.
opwvhk commented on pull request #1413:
URL: https://github.com/apache/avro/pull/1413#issuecomment-977173392
Force pushed on the original branch because too many commits came in.
--
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: issues-unsubscribe@avro.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [avro] RyanSkraba merged pull request #1413: AVRO-2019: Improve docs for logical type annotation
Posted by GitBox <gi...@apache.org>.
RyanSkraba merged pull request #1413:
URL: https://github.com/apache/avro/pull/1413
--
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-unsubscribe@avro.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [avro] martin-g commented on a change in pull request #1413: AVRO-2019: Improve docs for logical type annotation
Posted by GitBox <gi...@apache.org>.
martin-g commented on a change in pull request #1413:
URL: https://github.com/apache/avro/pull/1413#discussion_r766099764
##########
File path: doc/src/content/xdocs/idl.xml
##########
@@ -252,6 +252,14 @@ record Job {
time_ms submitTime;
timestamp_ms finishTime;
decimal(9,2) finishRatio;
+}
+ </source>
+ <p>Logical types can also be specified via an annotation, which is useful for logical types for which a keyword does not exist:</p>
+ <source>
+record Job {
+ string jobid;
+ @logicalType("timestamp-micros")
+ long finishTime;
Review comment:
Copied to the new website: https://github.com/martin-g/avro-website/commit/f685368ff8d211494c2ea84e059cc57d4bb3adf9
--
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: issues-unsubscribe@avro.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org