Skip to content

[MINOR][DOCS] Fix some links for python api doc #28017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

[MINOR][DOCS] Fix some links for python api doc #28017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f6bd4ec
[MINOR][DOCS] Fix some links for python api doc
yaooqinn Mar 25, 2020
2fd8b3b
style fix
yaooqinn Mar 25, 2020
b4d0fc7
address cmts
yaooqinn Mar 25, 2020
a959d6a
fix style
yaooqinn Mar 25, 2020
6d45125
Revert "fix style"
yaooqinn Mar 25, 2020
5346870
fix link
yaooqinn Mar 25, 2020
aaa1594
dep
yaooqinn Mar 25, 2020
a1fbefe
Revert "dep"
yaooqinn Mar 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions python/pyspark/sql/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1196,8 +1196,6 @@ def to_date(col, format=None):
By default, it follows casting rules to :class:`pyspark.sql.types.DateType` if the format
is omitted. Equivalent to ``col.cast("date")``.

.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> df = spark.createDataFrame([('1997-02-28 10:30:00',)], ['t'])
>>> df.select(to_date(df.t).alias('date')).collect()
[Row(date=datetime.date(1997, 2, 28))]
Expand All @@ -1221,8 +1219,6 @@ def to_timestamp(col, format=None):
By default, it follows casting rules to :class:`pyspark.sql.types.TimestampType` if the format
is omitted. Equivalent to ``col.cast("timestamp")``.

.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> df = spark.createDataFrame([('1997-02-28 10:30:00',)], ['t'])
>>> df.select(to_timestamp(df.t).alias('dt')).collect()
[Row(dt=datetime.datetime(1997, 2, 28, 10, 30))]
Expand Down
9 changes: 2 additions & 7 deletions python/pyspark/sql/readwriter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,8 @@ def json(self, path, schema=None, primitivesAsString=None, prefersDecimal=None,
:param recursiveFileLookup: recursively scan a directory for files. Using this option
disables `partition discovery`_.

.. _partition discovery: /sql-data-sources-parquet.html#partition-discovery
.. _partition discovery:
https://spark.apache.org/docs/latest/sql-data-sources-parquet.html#partition-discovery
.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> df1 = spark.read.json('python/test_support/sql/people.json')
Expand Down Expand Up @@ -490,8 +491,6 @@ def csv(self, path, schema=None, sep=None, encoding=None, quote=None, escape=Non
:param recursiveFileLookup: recursively scan a directory for files. Using this option
disables `partition discovery`_.

.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> df = spark.read.csv('python/test_support/sql/ages.csv')
>>> df.dtypes
[('_c0', 'string'), ('_c1', 'string')]
Expand Down Expand Up @@ -865,8 +864,6 @@ def json(self, path, mode=None, compression=None, dateFormat=None, timestampForm
:param ignoreNullFields: Whether to ignore null fields when generating JSON objects.
If None is set, it uses the default value, ``true``.

.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> df.write.json(os.path.join(tempfile.mkdtemp(), 'data'))
"""
self.mode(mode)
Expand Down Expand Up @@ -981,8 +978,6 @@ def csv(self, path, mode=None, compression=None, sep=None, quote=None, escape=No
:param lineSep: defines the line separator that should be used for writing. If None is
set, it uses the default value, ``\\n``. Maximum length is 1 character.

.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> df.write.csv(os.path.join(tempfile.mkdtemp(), 'data'))
"""
self.mode(mode)
Expand Down
5 changes: 2 additions & 3 deletions python/pyspark/sql/streaming.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,8 @@ def json(self, path, schema=None, primitivesAsString=None, prefersDecimal=None,
:param recursiveFileLookup: recursively scan a directory for files. Using this option
disables `partition discovery`_.

.. _partition discovery: /sql-data-sources-parquet.html#partition-discovery
.. _partition discovery:
https://spark.apache.org/docs/latest/sql-data-sources-parquet.html#partition-discovery
.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> json_sdf = spark.readStream.json(tempfile.mkdtemp(), schema = sdf_schema)
Expand Down Expand Up @@ -725,8 +726,6 @@ def csv(self, path, schema=None, sep=None, encoding=None, quote=None, escape=Non
:param recursiveFileLookup: recursively scan a directory for files. Using this option
disables `partition discovery`_.

.. _datetime pattern: https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html

>>> csv_sdf = spark.readStream.csv(tempfile.mkdtemp(), schema = sdf_schema)
>>> csv_sdf.isStreaming
True
Expand Down