zentol commented on a change in pull request #7402: [hotfix][docs] Fulfill some
empty description in Config Doc
URL: https://github.com/apache/flink/pull/7402#discussion_r245254995
##########
File path:
flink-core/src/main/java/org/apache/flink/configuration/WebOptions.java
##########
@@ -89,78 +95,89 @@
public static final ConfigOption<String> UPLOAD_DIR =
key("web.upload.dir")
.noDefaultValue()
- .withDeprecatedKeys("jobmanager.web.upload.dir");
+ .withDeprecatedKeys("jobmanager.web.upload.dir")
+ .withDescription("The config parameter defining the
directory for uploading the job jars. If not" +
+ " specified a dynamic directory will be used
under the directory specified by JOB_MANAGER_WEB_TMPDIR_KEY.");
/**
* The config parameter defining the number of archived jobs for the
jobmanager.
*/
public static final ConfigOption<Integer> ARCHIVE_COUNT =
key("web.history")
.defaultValue(5)
- .withDeprecatedKeys("jobmanager.web.history");
+ .withDeprecatedKeys("jobmanager.web.history")
+ .withDescription("The config parameter defining the
number of archived jobs for the jobmanager.");
/**
* The log file location (may be in /log for standalone but under log
directory when using YARN).
*/
public static final ConfigOption<String> LOG_PATH =
key("web.log.path")
.noDefaultValue()
- .withDeprecatedKeys("jobmanager.web.log.path");
+ .withDeprecatedKeys("jobmanager.web.log.path")
+ .withDescription("Define the log file location (may be
in /log for standalone but under log directory when using YARN).");
Review comment:
let's get some consistency in here. Some descriptions start with `The config
parameter`, others with `Config parameter defining`, and others with `Define`.
I know you just copied the javadocs, but imo this isn't sufficient for the
docs.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
