You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/10/25 12:43:14 UTC
[GitHub] [spark] derhagen opened a new pull request, #38389: Sphinx stubs
derhagen opened a new pull request, #38389:
URL: https://github.com/apache/spark/pull/38389
### What changes were proposed in this pull request?
The documentation under https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/data_types.html chops off the stubs on periods with a subsequent space. This leads to weird stubs when "i.e." is used. This PR escapes the subsequent spaces.
### Why are the changes needed?
see above.
### Does this PR introduce _any_ user-facing change?
This changes the documentation under https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/data_types.html
### How was this patch tested?
manual build
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] github-actions[bot] closed pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
URL: https://github.com/apache/spark/pull/38389
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #38389:
URL: https://github.com/apache/spark/pull/38389#discussion_r1004983111
##########
python/pyspark/sql/types.py:
##########
@@ -350,21 +350,21 @@ class FloatType(FractionalType, metaclass=DataTypeSingleton):
class ByteType(IntegralType):
- """Byte data type, i.e. a signed integer in a single byte."""
+ """Byte data type, i.e.\ a signed integer in a single byte."""
Review Comment:
Yeah see https://www.flake8rules.com/rules/W605.html
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #38389:
URL: https://github.com/apache/spark/pull/38389#discussion_r1004597021
##########
python/pyspark/sql/types.py:
##########
@@ -350,21 +350,21 @@ class FloatType(FractionalType, metaclass=DataTypeSingleton):
class ByteType(IntegralType):
- """Byte data type, i.e. a signed integer in a single byte."""
+ """Byte data type, i.e.\ a signed integer in a single byte."""
Review Comment:
https://github.com/derhagen/spark/actions/runs/3320974911/jobs/5488038542
Actually the linter fails. Feel free to rephrase it to something else like "For example"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] github-actions[bot] commented on pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38389:
URL: https://github.com/apache/spark/pull/38389#issuecomment-1418313171
We're closing this PR because it hasn't been updated in a while. This isn't a judgement on the merit of the PR in any way. It's just a way of keeping the PR queue manageable.
If you'd like to revive this PR, please reopen it and ask a committer to remove the Stale tag!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] derhagen commented on a diff in pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
Posted by GitBox <gi...@apache.org>.
derhagen commented on code in PR #38389:
URL: https://github.com/apache/spark/pull/38389#discussion_r1004921558
##########
python/pyspark/sql/types.py:
##########
@@ -350,21 +350,21 @@ class FloatType(FractionalType, metaclass=DataTypeSingleton):
class ByteType(IntegralType):
- """Byte data type, i.e. a signed integer in a single byte."""
+ """Byte data type, i.e.\ a signed integer in a single byte."""
Review Comment:
While that's a pragmatic solution, it feels kind off odd. backslash+space is used in a couple of edge-cases in sphinx. Is it expected that the linter checks docstrings?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on PR #38389:
URL: https://github.com/apache/spark/pull/38389#issuecomment-1291778824
Can one of the admins verify this patch?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] derhagen commented on a diff in pull request #38389: [MINOR][DOCS][PYTHON] Fix the truncation of API reference in several DataTypes
Posted by GitBox <gi...@apache.org>.
derhagen commented on code in PR #38389:
URL: https://github.com/apache/spark/pull/38389#discussion_r1008071665
##########
python/pyspark/sql/types.py:
##########
@@ -350,21 +350,21 @@ class FloatType(FractionalType, metaclass=DataTypeSingleton):
class ByteType(IntegralType):
- """Byte data type, i.e. a signed integer in a single byte."""
+ """Byte data type, i.e.\ a signed integer in a single byte."""
Review Comment:
starting the docstrings with an 'r' string prefix might be the right thing to do here, but I'm travelling right now. I'll test it next week, if I find the time.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org