reswqa opened a new pull request, #19888:
URL: https://github.com/apache/flink/pull/19888
## What is the purpose of the change
if a config option has @ExcludeFromDocumentation annotation, it will not
appear in the document. But for an enumeration type, sometimes we only want
some of its constant values not to appear in the document, this pull request
fulfilled this requirement.
## Brief change log
- *let configOptionsDocGenerator take care of ExcludeFromDocumentation
annotation when getEnumOptionsDescription*
## Verifying this change
This change added tests and can be verified by
org.apache.flink.docs.configuration.ConfigOptionsDocGeneratorTest#TestConfigGroupWithEnumConstantExclusion
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
--
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]
