[GitHub] spark pull request #15947: [SPARK-18447][DOCS] Fix the markdown for `Note:`/...

[HyukjinKwon]

GitHub user HyukjinKwon opened a pull request:

    https://github.com/apache/spark/pull/15947

    [SPARK-18447][DOCS] Fix the markdown for `Note:`/`NOTE:`/`Note that` across 
Python API documentation

    ## What changes were proposed in this pull request?
    
    It seems in Python, there are
    
    - `Note:`
    - `NOTE:`
    - `Note that`
    - `.. note::`
    
    This PR proposes to fix those to `.. note::` to be consistent.
    
    **Before**
    
    <img width="567" alt="2016-11-21 1 18 49" 
src="https://cloud.githubusercontent.com/assets/6477701/20464305/85144c86-af88-11e6-8ee9-90f584dd856c.png";>
    
    
    <img width="617" alt="2016-11-21 12 42 43" 
src="https://cloud.githubusercontent.com/assets/6477701/20464263/27be5022-af88-11e6-8577-4bbca7cdf36c.png";>
    
    **After**
    
    <img width="554" alt="2016-11-21 1 18 42" 
src="https://cloud.githubusercontent.com/assets/6477701/20464306/8fe48932-af88-11e6-83e1-fc3cbf74407d.png";>
    
    
    <img width="628" alt="2016-11-21 12 42 51" 
src="https://cloud.githubusercontent.com/assets/6477701/20464264/2d3e156e-af88-11e6-93f3-cab8d8d02983.png";>
    
    
    ## How was this patch tested?
    
    The notes were found via
    
    ```bash 
    grep -r "Note: " .
    grep -r "NOTE: " .
    grep -r "Note that " .
    ```
    
    And then fixed one by one comparing with API documentation.
    
    After that, manually tested via `make html` under `./python/docs`.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/HyukjinKwon/spark SPARK-18447

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/spark/pull/15947.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #15947
    
----
commit 2b2315b14811668f93c19774ee69d38cac57a789
Author: hyukjinkwon <gurwls...@gmail.com>
Date:   2016-11-20T15:27:37Z

    Fix the markdown for `Note:`/`NOTE:`/`Note that` across Python API 
documentation

commit 27878c8686482fa25016a27df92bf30ead1be4c6
Author: hyukjinkwon <gurwls...@gmail.com>
Date:   2016-11-20T15:30:13Z

    Consistent indentation

commit ca27e47aec6f2afbdccc3da7851bae7270fa5598
Author: hyukjinkwon <gurwls...@gmail.com>
Date:   2016-11-20T15:33:04Z

    Second consistent indentation

commit c4c94ba77f25df2d67c729d99d066d5da00c8b5b
Author: hyukjinkwon <gurwls...@gmail.com>
Date:   2016-11-20T15:52:03Z

    Disable not marked-down one

commit 46173a3d652773bfebc010ba6af76fb6c9916526
Author: hyukjinkwon <gurwls...@gmail.com>
Date:   2016-11-20T16:06:50Z

    Capitalize the sentences consistently

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

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