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/09/20 04:55:36 UTC

[GitHub] [avro] radai-rosenblatt opened a new pull request #1342: AVRO-3212: fix specification to allow doc in fixed types

radai-rosenblatt opened a new pull request #1342:
URL: https://github.com/apache/avro/pull/1342


   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   https://issues.apache.org/jira/browse/AVRO-3212
   
   - [ ] 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-XXX
     - 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
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### Commits
   
   - [ ] 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
   
   - [ ] 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] martin-g commented on a change in pull request #1342: AVRO-3212: fix specification to allow doc in fixed types

Posted by GitBox <gi...@apache.org>.
martin-g commented on a change in pull request #1342:
URL: https://github.com/apache/avro/pull/1342#discussion_r711883732



##########
File path: doc/src/content/xdocs/spec.xml
##########
@@ -254,14 +254,16 @@
         <section>
           <title>Fixed</title>
           <p>Fixed uses the type name <code>"fixed"</code> and supports
-          two attributes:</p>
+          the following attributes:</p>
 	  <ul>
 	    <li><code>name</code>: a string naming this fixed (required).</li>
 	    <li><em>namespace</em>, a string that qualifies the name;</li>

Review comment:
       A few questions to Avro devs not directly related to this PR: 
   1) Should we add `(optional)` for namespace too ?
   2) Why it uses `<em>` instead of `<code>` like all other attributes ?




-- 
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] radai-rosenblatt commented on a change in pull request #1342: AVRO-3212: fix specification to allow doc in fixed types

Posted by GitBox <gi...@apache.org>.
radai-rosenblatt commented on a change in pull request #1342:
URL: https://github.com/apache/avro/pull/1342#discussion_r712285901



##########
File path: doc/src/content/xdocs/spec.xml
##########
@@ -254,14 +254,16 @@
         <section>
           <title>Fixed</title>
           <p>Fixed uses the type name <code>"fixed"</code> and supports
-          two attributes:</p>
+          the following attributes:</p>
 	  <ul>
 	    <li><code>name</code>: a string naming this fixed (required).</li>
 	    <li><em>namespace</em>, a string that qualifies the name;</li>

Review comment:
       changed &lt;em&gt; to &lt;code&gt; for namespace - at least I cant think of a reason why it's different?
   i agree namespace should be marked optional (it is. it is also ignored if name has dots in it), but will leave that to a committer to decide




-- 
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] radai-rosenblatt commented on a change in pull request #1342: AVRO-3212: fix specification to allow doc in fixed types

Posted by GitBox <gi...@apache.org>.
radai-rosenblatt commented on a change in pull request #1342:
URL: https://github.com/apache/avro/pull/1342#discussion_r712285901



##########
File path: doc/src/content/xdocs/spec.xml
##########
@@ -254,14 +254,16 @@
         <section>
           <title>Fixed</title>
           <p>Fixed uses the type name <code>"fixed"</code> and supports
-          two attributes:</p>
+          the following attributes:</p>
 	  <ul>
 	    <li><code>name</code>: a string naming this fixed (required).</li>
 	    <li><em>namespace</em>, a string that qualifies the name;</li>

Review comment:
       change <em> to <code> for namespace - at least I cant think of a reason why it's different?
   i agree namespace should be marked optional (it is. it is also ignored is name has dots in it), but will leave that to a committer to decide




-- 
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 #1342: AVRO-3212: fix specification to allow doc in fixed types

Posted by GitBox <gi...@apache.org>.
RyanSkraba merged pull request #1342:
URL: https://github.com/apache/avro/pull/1342


   


-- 
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] radai-rosenblatt commented on a change in pull request #1342: AVRO-3212: fix specification to allow doc in fixed types

Posted by GitBox <gi...@apache.org>.
radai-rosenblatt commented on a change in pull request #1342:
URL: https://github.com/apache/avro/pull/1342#discussion_r712285901



##########
File path: doc/src/content/xdocs/spec.xml
##########
@@ -254,14 +254,16 @@
         <section>
           <title>Fixed</title>
           <p>Fixed uses the type name <code>"fixed"</code> and supports
-          two attributes:</p>
+          the following attributes:</p>
 	  <ul>
 	    <li><code>name</code>: a string naming this fixed (required).</li>
 	    <li><em>namespace</em>, a string that qualifies the name;</li>

Review comment:
       changed &lt;em&gt; to &lt;code&gt; for namespace - at least I cant think of a reason why it's different?
   i agree namespace should be marked optional (it is. it is also ignored is name has dots in it), but will leave that to a committer to decide




-- 
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] martin-g commented on a change in pull request #1342: AVRO-3212: fix specification to allow doc in fixed types

Posted by GitBox <gi...@apache.org>.
martin-g commented on a change in pull request #1342:
URL: https://github.com/apache/avro/pull/1342#discussion_r712797736



##########
File path: doc/src/content/xdocs/spec.xml
##########
@@ -254,14 +254,16 @@
         <section>
           <title>Fixed</title>
           <p>Fixed uses the type name <code>"fixed"</code> and supports
-          two attributes:</p>
+          the following attributes:</p>
 	  <ul>
 	    <li><code>name</code>: a string naming this fixed (required).</li>
 	    <li><em>namespace</em>, a string that qualifies the name;</li>

Review comment:
       You have changed two occurrences of `<em>` but there are two more. IMO, if we do this change then we should do it for all of the occurrences.




-- 
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] martin-g commented on a change in pull request #1342: AVRO-3212: fix specification to allow doc in fixed types

Posted by GitBox <gi...@apache.org>.
martin-g commented on a change in pull request #1342:
URL: https://github.com/apache/avro/pull/1342#discussion_r711883732



##########
File path: doc/src/content/xdocs/spec.xml
##########
@@ -254,14 +254,16 @@
         <section>
           <title>Fixed</title>
           <p>Fixed uses the type name <code>"fixed"</code> and supports
-          two attributes:</p>
+          the following attributes:</p>
 	  <ul>
 	    <li><code>name</code>: a string naming this fixed (required).</li>
 	    <li><em>namespace</em>, a string that qualifies the name;</li>

Review comment:
       A few questions not directly related to this PR: 
   1) Should we add `(optional)` for namespace too ?
   2) Why it uses `<em>` instead of `<code>` like all other attributes ?




-- 
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