[
https://issues.apache.org/jira/browse/AVRO-3076?focusedWorklogId=779682&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-779682
]
ASF GitHub Bot logged work on AVRO-3076:
----------------------------------------
Author: ASF GitHub Bot
Created on: 08/Jun/22 21:58
Start Date: 08/Jun/22 21:58
Worklog Time Spent: 10m
Work Description: rgroothuijsen opened a new pull request, #1715:
URL: https://github.com/apache/avro/pull/1715
This PR updates the `useCustomCoders()` documentation for `SpecificData` and
`ReflectData`. In the case of `SpecificData` it specifies the correct default,
and in the case of `ReflectData` it overrides the documentation it inherited
from `SpecificData` in order to clarify that custom coders are unsupported.
### 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-3076
### Tests
- [X] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
This PR only includes documentation updates.
Issue Time Tracking
-------------------
Worklog Id: (was: 779682)
Remaining Estimate: 0h
Time Spent: 10m
> Wrong javadoc documentation for useCustomCoders
> -----------------------------------------------
>
> Key: AVRO-3076
> URL: https://issues.apache.org/jira/browse/AVRO-3076
> Project: Apache Avro
> Issue Type: Bug
> Components: java
> Affects Versions: 1.10.1
> Reporter: Emilio Jose Mena Cebrian
> Priority: Minor
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Javadoc says that useCustomCoder defaults to true:
>
>
> {code:java}
> /**
> * Retrieve the current value of the custom-coders feature flag.
> Defaults to
> * <code>true</code>, but this default can be overriden using the
> system
> * property
> <code>org.apache.avro.specific.use_custom_coders</code>, and can be
> * set dynamically by {@link SpecificData#useCustomCoders()}. See <a
> *
> href="https://avro.apache.org/docs/current/gettingstartedjava.html#Beta+feature:+Generating+faster+code"Getting
> * started with Java</a> for more about this feature flag.
> */
> {code}
> But in fact it defaults to "false"
>
>
> {code:java}
> private boolean useCustomCoderFlag = Boolean
> .parseBoolean(System.getProperty("org.apache.avro.specific.use_custom_coders",
> "false"));
>
>
>
> {code}
>
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
