[jira] [Updated] (KAFKA-18259) Documentation for consumer auto.offset.reset contains invalid HTML

[Andrew Schofield (Jira)]

     [ 
https://issues.apache.org/jira/browse/KAFKA-18259?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Andrew Schofield updated KAFKA-18259:
-------------------------------------
    Description: 
The auto.offset.reset config now permits `by_duration:<duration>`. However, the 
documentation for this config needs some care because it is turned into HTML. 
In particular, the `<duration>` is not allowed and should be `
{noformat}
&lt;duration&gt;
{noformat}
` instead.

Also, the `AutoOffsetResetStrategy.Validator` class needs a `toString()` method 
since the documentation will contain the result of calling that method on the 
validator.

  was:
The auto.offset.reset config now permits `by_duration:<duration>`. However, the 
documentation for this config needs some care because it is turned into HTML. 
In particular, the `<duration>` is not allowed and should be `&lt;duration&gt;` 
instead.

Also, the `AutoOffsetResetStrategy.Validator` class needs a `toString()` method 
since the documentation will contain the result of calling that method on the 
validator.


> Documentation for consumer auto.offset.reset contains invalid HTML
> ------------------------------------------------------------------
>
>                 Key: KAFKA-18259
>                 URL: https://issues.apache.org/jira/browse/KAFKA-18259
>             Project: Kafka
>          Issue Type: Bug
>          Components: clients
>    Affects Versions: 4.0.0
>            Reporter: Andrew Schofield
>            Priority: Minor
>
> The auto.offset.reset config now permits `by_duration:<duration>`. However, 
> the documentation for this config needs some care because it is turned into 
> HTML. In particular, the `<duration>` is not allowed and should be `
> {noformat}
> &lt;duration&gt;
> {noformat}
> ` instead.
> Also, the `AutoOffsetResetStrategy.Validator` class needs a `toString()` 
> method since the documentation will contain the result of calling that method 
> on the validator.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)