[spark] branch master updated: [SPARK-35582][PYTHON][DOCS] Remove # noqa in Python API documents

[gurwls223]

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

gurwls223 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 fe09def  [SPARK-35582][PYTHON][DOCS] Remove # noqa in Python API 
documents
fe09def is described below

commit fe09def3231600e52cb58aaba5f72af33ab4dc33
Author: itholic <haejoon....@databricks.com>
AuthorDate: Tue Jun 1 15:24:04 2021 +0900

    [SPARK-35582][PYTHON][DOCS] Remove # noqa in Python API documents
    
    ### What changes were proposed in this pull request?
    
    This PR aims to move `# noqa` in the Python docstring to the proper place 
so that hide them from the official documents.
    
    ### Why are the changes needed?
    
    If we don't move `# noqa` to the proper place, it is exposed in the middle 
of the docstring, and it looks a bit wired as below:
    <img width="613" alt="Screen Shot 2021-06-01 at 3 17 52 PM" 
src="https://user-images.githubusercontent.com/44108233/120275617-91da3800-c2ec-11eb-9778-16c5fe789418.png";>
    
    ### Does this PR introduce _any_ user-facing change?
    
    Yes, the `# noqa` is no more shown in the documents as below:
    <img width="609" alt="Screen Shot 2021-06-01 at 3 21 00 PM" 
src="https://user-images.githubusercontent.com/44108233/120275927-fbf2dd00-c2ec-11eb-950d-346af2745711.png";>
    
    ### How was this patch tested?
    
    Manually build docs and check.
    
    Closes #32728 from itholic/SPARK-35582.
    
    Authored-by: itholic <haejoon....@databricks.com>
    Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
---
 python/pyspark/sql/functions.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/python/pyspark/sql/functions.py b/python/pyspark/sql/functions.py
index cd7cadb..49401cc 100644
--- a/python/pyspark/sql/functions.py
+++ b/python/pyspark/sql/functions.py
@@ -3712,9 +3712,11 @@ def schema_of_json(json, options=None):
         a JSON string or a foldable string column containing a JSON string.
     options : dict, optional
         options to control parsing. accepts the same options as the JSON 
datasource.
-        See `Data Source Option 
<https://spark.apache.org/docs/latest/sql-data-sources-json.html#data-source-option>`_
  # noqa
+        See `Data Source Option 
<https://spark.apache.org/docs/latest/sql-data-sources-json.html#data-source-option>`_
         in the version you use.
 
+        .. # noqa
+
         .. versionchanged:: 3.0
            It accepts `options` parameter to control schema inferring.
 

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