HyukjinKwon commented on a change in pull request #27459:
[SPARK-30510][SQL][DOCS] Publicly document Spark SQL configuration options
URL: https://github.com/apache/spark/pull/27459#discussion_r375011017
##########
File path: sql/gen-sql-markdown.py
##########
@@ -218,9 +236,73 @@ def generate_sql_markdown(jvm, path):
mdfile.write("<br/>\n\n")
+def generate_sql_configs_table(jvm, path):
+ """
+ Generates an HTML table at `path` that lists all public SQL
+ configuration options.
+ """
+ sql_configs = _list_sql_configs(jvm)
+ value_reference_pattern = re.compile(r"^<value of (\S*)>$")
+ # ConfigEntry(key=spark.buffer.size, defaultValue=65536, doc=, public=true)
+ config_entry_pattern = re.compile(
+ r"ConfigEntry\(key=(\S*), defaultValue=\S*, doc=\S*, public=\S*\)")
Review comment:
https://github.com/apache/spark/pull/27459#pullrequestreview-353408300, it
is difficult to add a test case for documentation itself. The entries are
generated from `getAllDefinedConfs` and seem `getAllDefinedConfs` is properly
tested.
To make absolutely sure, we could add an assert here extracted `public` is
`true`.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
