(spark) branch master updated: [SPARK-50608][SQL][DOCS] Fix malformed configuration page caused by unclosed tags

[yao]

This is an automated email from the ASF dual-hosted git repository.

yao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new ac91a7d3eac9 [SPARK-50608][SQL][DOCS] Fix malformed configuration page 
caused by unclosed tags
ac91a7d3eac9 is described below

commit ac91a7d3eac92d57963e6cefd0d35705e5afd296
Author: Kent Yao <y...@apache.org>
AuthorDate: Thu Dec 26 13:53:26 2024 +0800

    [SPARK-50608][SQL][DOCS] Fix malformed configuration page caused by 
unclosed tags
    
    ### What changes were proposed in this pull request?
    
    Fix the malformed configuration page caused by unclosed tags
    
    ### Why are the changes needed?
    docfix
    
    ### Does this PR introduce _any_ user-facing change?
    no
    
    ### How was this patch tested?
    
    #### Before
    
    
![image](https://github.com/user-attachments/assets/d5fe7630-a26f-48cb-8bc3-9a93155eeef1)
    
    #### After
    
    
![image](https://github.com/user-attachments/assets/57bcbfdf-b5b5-43ba-ab60-89dc062f6016)
    
    ### Was this patch authored or co-authored using generative AI tooling?
    
    no
    
    Closes #49223 from yaooqinn/SPARK-50608.
    
    Authored-by: Kent Yao <y...@apache.org>
    Signed-off-by: Kent Yao <y...@apache.org>
---
 sql/gen-sql-config-docs.py | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/sql/gen-sql-config-docs.py b/sql/gen-sql-config-docs.py
index b69a903b44f9..4db22ff3b8e4 100644
--- a/sql/gen-sql-config-docs.py
+++ b/sql/gen-sql-config-docs.py
@@ -103,6 +103,14 @@ def generate_sql_configs_table_html(sql_configs, path):
                     )
                 )
 
+            if config.name == "spark.sql.files.ignoreInvalidPartitionPaths":
+                description = config.description.replace("<", 
"&lt;").replace(">", "&gt;")
+            elif config.name == "spark.sql.hive.quoteHiveStructFieldName":
+                description = config.description.replace(
+                    "<", "&lt;").replace(">", "&gt;").replace("`", "&#96;")
+            else:
+                description = config.description
+
             f.write(dedent(
                 """
                 <tr>
@@ -115,7 +123,7 @@ def generate_sql_configs_table_html(sql_configs, path):
                 .format(
                     name=config.name,
                     default=default,
-                    description=markdown.markdown(config.description),
+                    description=markdown.markdown(description),
                     version=config.version
                 )
             ))


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org