You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "itholic (via GitHub)" <gi...@apache.org> on 2023/11/25 10:06:47 UTC
[PR] [SPARK-46099][PS][DOCS] Refactor "Supported pandas API" generation script [spark]
itholic opened a new pull request, #44010:
URL: https://github.com/apache/spark/pull/44010
### What changes were proposed in this pull request?
This PR proposes to refactor the script used to generate the [Supported pandas API](https://spark.apache.org/docs/latest/api/python/user_guide/pandas_on_spark/supported_pandas_api.html) documentation. The script has been restructured for better readability and maintainability. The refactoring includes:
- Simplifying complex functions and breaking them into smaller, more manageable pieces.
- Improving variable and function naming for clarity.
- Adding comprehensive docstrings in the NumPy docstyle.
- Streamlining the flow of the script to enhance logical coherence.
### Why are the changes needed?
The previous version of the script was hard to understand and maintain due to its complexity and lack of documentation. This refactoring makes the script more accessible to new contributors and easier to modify or extend in the future. It also ensures that the script adheres to best practices in Python coding, making it a more reliable tool for generating accurate and up-to-date documentation.
### Does this PR introduce _any_ user-facing change?
No user-facing changes. This PR only affects the internal documentation generation process.
### How was this patch tested?
Tested by generating the documentation manually and verifying that the output remains consistent with the previous version.
### 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] [SPARK-46099][PS][DOCS] Refactor "Supported pandas API" generation script [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44010:
URL: https://github.com/apache/spark/pull/44010#issuecomment-1826945706
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
Re: [PR] [SPARK-46099][PS][DOCS] Refactor "Supported pandas API" generation script [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #44010: [SPARK-46099][PS][DOCS] Refactor "Supported pandas API" generation script
URL: https://github.com/apache/spark/pull/44010
--
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