[SPARK-33003][PYTHON][DOCS] Add type hints guidelines to the documentation#30094
[SPARK-33003][PYTHON][DOCS] Add type hints guidelines to the documentation#30094zero323 wants to merge 3 commits intoapache:masterfrom
Conversation
|
Test build #130022 has finished for PR 30094 at commit
|
|
Kubernetes integration test starting |
|
Kubernetes integration test status success |
|
Looks pretty good. Let me know when you think it's ready @zero323 |
|
Test build #130109 has finished for PR 30094 at commit
|
|
Kubernetes integration test starting |
|
Kubernetes integration test status failure |
|
Thanks for checking this @HyukjinKwon! I think it is ready for review ‒ I've modified grammar as requested and section about validating. As of user part, I decided against adding it for now. I have some hints, but these seem to be too localized (specific editors, common typing issues), while for most of the users, benefits will be mostly transparent. Maybe we could add a short guide for different environments (I have this answer on Stack, which seems to be weirdly popular) and add some typing notes there? |
|
Merged to master. |
|
Thanks @HyukjinKwon! |
What changes were proposed in this pull request?
Add type hints guidelines to developer docs.
Why are the changes needed?
Since it is a new and still somewhat evolving feature, we should provided clear guidelines for potential contributors.
Does this PR introduce any user-facing change?
No.
How was this patch tested?