[ 
https://issues.apache.org/jira/browse/FLINK-19263?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17196917#comment-17196917
 ] 

Chesnay Schepler commented on FLINK-19263:
------------------------------------------

For the main files this is fairly straight-forward (change 
{{parseDocumentedOptions}} to check the order), but the special sections are a 
problem since they have a custom sort order that you could only derive from the 
corresponding options.

> Enforce alphabetical order in configuration option docs
> -------------------------------------------------------
>
>                 Key: FLINK-19263
>                 URL: https://issues.apache.org/jira/browse/FLINK-19263
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation, Runtime / Configuration
>            Reporter: Chesnay Schepler
>            Priority: Major
>             Fix For: 1.12.0
>
>
> The ConfigDocsGenerator sorts options alphabetically, however there are no 
> checks to ensure that the generated files adhere to that order.
> This is a problem because time and time again these files are manually 
> modified, breaking the order, causing other PRs that then use the generator 
> to include unrelated changes.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to