[
https://issues.apache.org/jira/browse/AVRO-3294?focusedWorklogId=706125&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-706125
]
ASF GitHub Bot logged work on AVRO-3294:
----------------------------------------
Author: ASF GitHub Bot
Created on: 10/Jan/22 13:30
Start Date: 10/Jan/22 13:30
Worklog Time Spent: 10m
Work Description: opwvhk opened a new pull request #1453:
URL: https://github.com/apache/avro/pull/1453
Use the previously introduced method `DocCommentHandler#clearDoc()` to
generate warnings for misplaced documentation. Also add documentation to
describe the tricky bits when using this method.
The brittleness of the solution proves that doc comments as special
tokens are a hack. However, making regular tokens out of them may break
existing `.avdl` files.
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-3294
- 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~ updates the following unit tests ~__OR__ does not need
testing for this extremely good reason~:
- `org.apache.avro.compiler.idl.TestIdl#testDocCommentsAndWarnings`
- `input/comments.avdl` & `output/comments.avpr`
### 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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 706125)
Remaining Estimate: 0h
Time Spent: 10m
> IDL parsing allows doc ommentys in strange places
> -------------------------------------------------
>
> Key: AVRO-3294
> URL: https://issues.apache.org/jira/browse/AVRO-3294
> Project: Apache Avro
> Issue Type: Improvement
> Reporter: Oscar Westra van Holthe - Kind
> Priority: Minor
> Time Spent: 10m
> Remaining Estimate: 0h
>
> As demonstrated by the current test case
> {{TestIdl#testDocCommentsAndWarnings}} (and the files {{comments.avdl}} &
> {{comments.avpr}}), doc comments are not handled according to spec.
> Goal: use doc comments that are placed according to spec, and generate
> warnings for all misplaced doc comments.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
