[jira] [Created] (SPARK-34300) Fix of typos in documentation of pyspark.sql.functions and output of lint-python
David Toneian created SPARK-34300:
-
Summary: Fix of typos in documentation of pyspark.sql.functions
and output of lint-python
Key: SPARK-34300
URL: https://issues.apache.org/jira/browse/SPARK-34300
Project: Spark
Issue Type: Bug
Components: PySpark
Affects Versions: 3.0.1
Reporter: David Toneian
Minor documentation and standard output issues:
* {{dev/lint-python}} contains a typo when printing a warning regarding bad
Sphinx version ("lower then 3.1" rather than "lower than 3.1")
* The documentations of the functions {{lag}} and {{lead}} of
{{pyspark.sql.functions}} refer to a parameter {{defaultValue}}, which in
reality is named {{default}}.
* The documentation strings of functions in {{pyspark.sql.functions}} make
reference to the {{Column}} class, which is not resolved by Sphinx unless fully
qualified as {{pyspark.sql.Column}}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
-
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Commented] (SPARK-31739) Docstring syntax issues prevent proper compilation of documentation
[ https://issues.apache.org/jira/browse/SPARK-31739?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17109634#comment-17109634 ] David Toneian commented on SPARK-31739: --- Proposed a fix in [PR #28559|https://github.com/apache/spark/pull/28559]. > Docstring syntax issues prevent proper compilation of documentation > --- > > Key: SPARK-31739 > URL: https://issues.apache.org/jira/browse/SPARK-31739 > Project: Spark > Issue Type: Bug > Components: Documentation >Affects Versions: 2.4.5 >Reporter: David Toneian >Priority: Trivial > > Some docstrings contain mistakes, like missing or spurious spaces, which > prevent the documentation from being rendered as intended. -- This message was sent by Atlassian Jira (v8.3.4#803005) - To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Created] (SPARK-31739) Docstring syntax issues prevent proper compilation of documentation
David Toneian created SPARK-31739: - Summary: Docstring syntax issues prevent proper compilation of documentation Key: SPARK-31739 URL: https://issues.apache.org/jira/browse/SPARK-31739 Project: Spark Issue Type: Bug Components: Documentation Affects Versions: 2.4.5 Reporter: David Toneian Some docstrings contain mistakes, like missing or spurious spaces, which prevent the documentation from being rendered as intended. -- This message was sent by Atlassian Jira (v8.3.4#803005) - To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Commented] (SPARK-30859) Docstring syntax issues prevent proper compilation of documentation
[ https://issues.apache.org/jira/browse/SPARK-30859?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17038585#comment-17038585 ] David Toneian commented on SPARK-30859: --- I have proposed a fix in [PR #27613|https://github.com/apache/spark/pull/27613]. > Docstring syntax issues prevent proper compilation of documentation > --- > > Key: SPARK-30859 > URL: https://issues.apache.org/jira/browse/SPARK-30859 > Project: Spark > Issue Type: Bug > Components: Documentation >Affects Versions: 2.4.5 >Reporter: David Toneian >Priority: Trivial > > Some docstrings contain mistakes, like missing newlines or spurious spaces, > which prevent the documentation from being rendered as intended. -- This message was sent by Atlassian Jira (v8.3.4#803005) - To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Created] (SPARK-30859) Docstring syntax issues prevent proper compilation of documentation
David Toneian created SPARK-30859: - Summary: Docstring syntax issues prevent proper compilation of documentation Key: SPARK-30859 URL: https://issues.apache.org/jira/browse/SPARK-30859 Project: Spark Issue Type: Bug Components: Documentation Affects Versions: 2.4.5 Reporter: David Toneian Some docstrings contain mistakes, like missing newlines or spurious spaces, which prevent the documentation from being rendered as intended. -- This message was sent by Atlassian Jira (v8.3.4#803005) - To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Resolved] (SPARK-30823) %PYTHONPATH% not set in python/docs/make2.bat, resulting in failed/wrong documentation builds
[
https://issues.apache.org/jira/browse/SPARK-30823?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
David Toneian resolved SPARK-30823.
---
Resolution: Fixed
Merged in
[{{b2134ee}}|https://github.com/apache/spark/commit/b2134ee73cfad4d78aaf8f0a2898011ac0308e48].
> %PYTHONPATH% not set in python/docs/make2.bat, resulting in failed/wrong
> documentation builds
> -
>
> Key: SPARK-30823
> URL: https://issues.apache.org/jira/browse/SPARK-30823
> Project: Spark
> Issue Type: Bug
> Components: Documentation, PySpark, Windows
>Affects Versions: 2.4.5
> Environment: Tested on Windows 10.
>Reporter: David Toneian
>Priority: Minor
>
> When building the PySpark documentation on Windows, by changing directory to
> {{python/docs}} and running {{make.bat}} (which runs {{make2.bat}}), the
> majority of the documentation may not be built if {{pyspark}} is not in the
> default {{%PYTHONPATH%}}. Sphinx then reports that {{pyspark}} (and possibly
> dependencies) cannot be imported.
> If {{pyspark}} is in the default {{%PYTHONPATH%}}, I suppose it is that
> version of {{pyspark}} – as opposed to the version found above the
> {{python/docs}} directory – that is considered when building the
> documentation, which may result in documentation that does not correspond to
> the development version one is trying to build.
> {{python/docs/Makefile}} avoids this issue by setting
> ??export PYTHONPATH=$(realpath ..):$(realpath ../lib/py4j-0.10.8.1-src.zip)??
> on line 10, but {{make2.bat}} does no such thing. The fix consist of adding
> ??set PYTHONPATH=..;..\lib\py4j-0.10.8.1-src.zip??
> to {{make2.bat}}.
> See [GitHub PR #27569|https://github.com/apache/spark/pull/27569].
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
-
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Updated] (SPARK-30823) %PYTHONPATH% not set in python/docs/make2.bat, resulting in failed/wrong documentation builds
[
https://issues.apache.org/jira/browse/SPARK-30823?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
David Toneian updated SPARK-30823:
--
Description:
When building the PySpark documentation on Windows, by changing directory to
{{python/docs}} and running {{make.bat}} (which runs {{make2.bat}}), the
majority of the documentation may not be built if {{pyspark}} is not in the
default {{%PYTHONPATH%}}. Sphinx then reports that {{pyspark}} (and possibly
dependencies) cannot be imported.
If {{pyspark}} is in the default {{%PYTHONPATH%}}, I suppose it is that version
of {{pyspark}} – as opposed to the version found above the {{python/docs}}
directory – that is considered when building the documentation, which may
result in documentation that does not correspond to the development version one
is trying to build.
{{python/docs/Makefile}} avoids this issue by setting
??export PYTHONPATH=$(realpath ..):$(realpath ../lib/py4j-0.10.8.1-src.zip)??
on line 10, but {{make2.bat}} does no such thing. The fix consist of adding
??set PYTHONPATH=..;..\lib\py4j-0.10.8.1-src.zip??
to {{make2.bat}}.
See [GitHub PR #27569|https://github.com/apache/spark/pull/27569].
was:
When building the PySpark documentation on Windows, by changing directory to
{{python/docs}} and running {{make.bat}} (which runs {{make2.bat}}), the
majority of the documentation may not be built if {{pyspark}} is not in the
default {{%PYTHONPATH%}}. Sphinx then reports that {{pyspark}} (and possibly
dependencies) cannot be imported.
If {{pyspark}} is in the default {{%PYTHONPATH%}}, I suppose it is that version
of {{pyspark}} – as opposed to the version found above the {{python/docs}}
directory – that is considered when building the documentation, which may
result in documentation that does not correspond to the development version one
is trying to build.
{{python/docs/Makefile}} avoids this issue by setting
??export PYTHONPATH=$(realpath ..):$(realpath ../lib/py4j-0.10.8.1-src.zip)??
on line 10, but {{make2.bat}} does no such thing. The fix consist of adding
??set PYTHONPATH=..;..\lib\py4j-0.10.8.1-src.zip??
to {{make2.bat}}.
I will open a GitHub PR shortly.
> %PYTHONPATH% not set in python/docs/make2.bat, resulting in failed/wrong
> documentation builds
> -
>
> Key: SPARK-30823
> URL: https://issues.apache.org/jira/browse/SPARK-30823
> Project: Spark
> Issue Type: Bug
> Components: Documentation, PySpark, Windows
>Affects Versions: 2.4.5
> Environment: Tested on Windows 10.
>Reporter: David Toneian
>Priority: Minor
>
> When building the PySpark documentation on Windows, by changing directory to
> {{python/docs}} and running {{make.bat}} (which runs {{make2.bat}}), the
> majority of the documentation may not be built if {{pyspark}} is not in the
> default {{%PYTHONPATH%}}. Sphinx then reports that {{pyspark}} (and possibly
> dependencies) cannot be imported.
> If {{pyspark}} is in the default {{%PYTHONPATH%}}, I suppose it is that
> version of {{pyspark}} – as opposed to the version found above the
> {{python/docs}} directory – that is considered when building the
> documentation, which may result in documentation that does not correspond to
> the development version one is trying to build.
> {{python/docs/Makefile}} avoids this issue by setting
> ??export PYTHONPATH=$(realpath ..):$(realpath ../lib/py4j-0.10.8.1-src.zip)??
> on line 10, but {{make2.bat}} does no such thing. The fix consist of adding
> ??set PYTHONPATH=..;..\lib\py4j-0.10.8.1-src.zip??
> to {{make2.bat}}.
> See [GitHub PR #27569|https://github.com/apache/spark/pull/27569].
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
-
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Created] (SPARK-30823) %PYTHONPATH% not set in python/docs/make2.bat, resulting in failed/wrong documentation builds
David Toneian created SPARK-30823:
-
Summary: %PYTHONPATH% not set in python/docs/make2.bat, resulting
in failed/wrong documentation builds
Key: SPARK-30823
URL: https://issues.apache.org/jira/browse/SPARK-30823
Project: Spark
Issue Type: Bug
Components: Documentation, PySpark, Windows
Affects Versions: 2.4.5
Environment: Tested on Windows 10.
Reporter: David Toneian
When building the PySpark documentation on Windows, by changing directory to
{{python/docs}} and running {{make.bat}} (which runs {{make2.bat}}), the
majority of the documentation may not be built if {{pyspark}} is not in the
default {{%PYTHONPATH%}}. Sphinx then reports that {{pyspark}} (and possibly
dependencies) cannot be imported.
If {{pyspark}} is in the default {{%PYTHONPATH%}}, I suppose it is that version
of {{pyspark}} – as opposed to the version found above the {{python/docs}}
directory – that is considered when building the documentation, which may
result in documentation that does not correspond to the development version one
is trying to build.
{{python/docs/Makefile}} avoids this issue by setting
??export PYTHONPATH=$(realpath ..):$(realpath ../lib/py4j-0.10.8.1-src.zip)??
on line 10, but {{make2.bat}} does no such thing. The fix consist of adding
??set PYTHONPATH=..;..\lib\py4j-0.10.8.1-src.zip??
to {{make2.bat}}.
I will open a GitHub PR shortly.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
-
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
