Skip to content

[SPARK-33003][PYTHON][DOCS] Add type hints guidelines to the documentation#30094

Closed
zero323 wants to merge 3 commits intoapache:masterfrom
zero323:SPARK-33003
Closed

[SPARK-33003][PYTHON][DOCS] Add type hints guidelines to the documentation#30094
zero323 wants to merge 3 commits intoapache:masterfrom
zero323:SPARK-33003

Conversation

@zero323
Copy link
Member

@zero323 zero323 commented Oct 19, 2020

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?

@SparkQA
Copy link

SparkQA commented Oct 19, 2020

Test build #130022 has finished for PR 30094 at commit 6928aa4.

  • This patch fails PySpark unit tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Oct 19, 2020

Kubernetes integration test starting
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/34629/

@SparkQA
Copy link

SparkQA commented Oct 19, 2020

Kubernetes integration test status success
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/34629/

@HyukjinKwon
Copy link
Member

Looks pretty good. Let me know when you think it's ready @zero323

@HyukjinKwon HyukjinKwon changed the title [SPARK-33003][PYTHON][DOCS] Add type hints guideliness to the documentation [SPARK-33003][PYTHON][DOCS] Add type hints guidelines to the documentation Oct 20, 2020
@SparkQA
Copy link

SparkQA commented Oct 21, 2020

Test build #130109 has finished for PR 30094 at commit 88a04a7.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Oct 21, 2020

Kubernetes integration test starting
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/34718/

@SparkQA
Copy link

SparkQA commented Oct 21, 2020

Kubernetes integration test status failure
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/34718/

@zero323 zero323 marked this pull request as ready for review October 22, 2020 00:15
@zero323 zero323 marked this pull request as draft October 22, 2020 00:25
@zero323
Copy link
Member Author

zero323 commented Oct 23, 2020

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?

@zero323 zero323 marked this pull request as ready for review October 23, 2020 21:53
Copy link
Member

@HyukjinKwon HyukjinKwon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@HyukjinKwon
Copy link
Member

Merged to master.

@zero323
Copy link
Member Author

zero323 commented Oct 24, 2020

Thanks @HyukjinKwon!

@zero323 zero323 deleted the SPARK-33003 branch October 24, 2020 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants