diff options
author | hyukjinkwon <gurwls223@gmail.com> | 2016-11-22 11:40:18 +0000 |
---|---|---|
committer | Sean Owen <sowen@cloudera.com> | 2016-11-22 11:40:18 +0000 |
commit | 933a6548d423cf17448207a99299cf36fc1a95f6 (patch) | |
tree | 8244d8b993bce2cb023d0ad9dcaf037f34cb7378 /python/pyspark/sql/streaming.py | |
parent | 4922f9cdcac8b7c10320ac1fb701997fffa45d46 (diff) | |
download | spark-933a6548d423cf17448207a99299cf36fc1a95f6.tar.gz spark-933a6548d423cf17448207a99299cf36fc1a95f6.tar.bz2 spark-933a6548d423cf17448207a99299cf36fc1a95f6.zip |
[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`.
Author: hyukjinkwon <gurwls223@gmail.com>
Closes #15947 from HyukjinKwon/SPARK-18447.
Diffstat (limited to 'python/pyspark/sql/streaming.py')
-rw-r--r-- | python/pyspark/sql/streaming.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/python/pyspark/sql/streaming.py b/python/pyspark/sql/streaming.py index 0e4589be97..9c3a237699 100644 --- a/python/pyspark/sql/streaming.py +++ b/python/pyspark/sql/streaming.py @@ -90,10 +90,12 @@ class StreamingQuery(object): @since(2.0) def processAllAvailable(self): """Blocks until all available data in the source has been processed and committed to the - sink. This method is intended for testing. Note that in the case of continually arriving - data, this method may block forever. Additionally, this method is only guaranteed to block - until data that has been synchronously appended data to a stream source prior to invocation. - (i.e. `getOffset` must immediately reflect the addition). + sink. This method is intended for testing. + + .. note:: In the case of continually arriving data, this method may block forever. + Additionally, this method is only guaranteed to block until data that has been + synchronously appended data to a stream source prior to invocation. + (i.e. `getOffset` must immediately reflect the addition). """ return self._jsq.processAllAvailable() |