You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "nchammas (via GitHub)" <gi...@apache.org> on 2023/12/26 02:36:45 UTC
[PR] [MINOR][DOCS] Fix rst link in Python API docs for .sql() [spark]
nchammas opened a new pull request, #44488:
URL: https://github.com/apache/spark/pull/44488
### What changes were proposed in this pull request?
This PR fixes the rst markup for a link in the documentation for `pyspark.sql.SparkSession.sql` and `pyspark.pandas.sql`.
### Why are the changes needed?
The current markup is incorrect.
Technically, though the markup in this PR is correct, the link target is incorrect. We should be linking to page relative to the site root, rather than hardcoding a link to `/latest/`. However, I could not figure out how to do that in rst, and building the API docs takes a really long time, and I could not make it build incrementally.
### Does this PR introduce _any_ user-facing change?
Yes, the markup goes from looking like this:
To looking like this:
### How was this patch tested?
I built the docs as follows:
```
SKIP_SCALADOC=1 SKIP_RDOC=1 SKIP_SQLDOC=1 bundle exec jekyll serve
```
And reviewed the output in my browser.
### Was this patch authored or co-authored using generative AI tooling?
No.
--
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
Re: [PR] [MINOR][DOCS] Fix rst link in Python API docs for .sql() [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44488:
URL: https://github.com/apache/spark/pull/44488#issuecomment-1869210958
Build: https://github.com/nchammas/spark/actions/runs/7325659058/job/19950500574 (for my own ref)
--
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
Re: [PR] [MINOR][DOCS] Fix rst link in Python API docs for .sql() [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #44488: [MINOR][DOCS] Fix rst link in Python API docs for .sql()
URL: https://github.com/apache/spark/pull/44488
--
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
Re: [PR] [MINOR][DOCS] Fix rst link in Python API docs for .sql() [spark]
Posted by "nchammas (via GitHub)" <gi...@apache.org>.
nchammas commented on PR #44488:
URL: https://github.com/apache/spark/pull/44488#issuecomment-1869208844
cc @MaxGekk since `git blame` suggests you wrote the docs I am editing in this PR.
--
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
Re: [PR] [MINOR][DOCS] Fix rst link in Python API docs for .sql() [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44488:
URL: https://github.com/apache/spark/pull/44488#issuecomment-1869277788
Merged to master.
--
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