Skip to content

[MINOR][DOCS] Add KMeansSummary and InheritableThread to documentation#29470

Closed
srowen wants to merge 2 commits intoapache:masterfrom
srowen:KMeansSummary
Closed

[MINOR][DOCS] Add KMeansSummary and InheritableThread to documentation#29470
srowen wants to merge 2 commits intoapache:masterfrom
srowen:KMeansSummary

Conversation

@srowen
Copy link
Member

@srowen srowen commented Aug 18, 2020

What changes were proposed in this pull request?

The class KMeansSummary in pyspark is not included in clustering.py's __all__ declaration. It isn't included in the docs as a result.

InheritableThread and KMeansSummary should be into corresponding RST files for documentation.

Why are the changes needed?

It seems like an oversight to not include this as all similar "summary" classes are.
InheritableThread should also be documented.

Does this PR introduce any user-facing change?

I don't believe there are functional changes. It should make this public class appear in docs.

How was this patch tested?

Existing tests / N/A.

@srowen
Copy link
Member Author

srowen commented Aug 18, 2020

CC @huaxingao right?

@SparkQA
Copy link

SparkQA commented Aug 18, 2020

Test build #127600 has finished for PR 29470 at commit d048aee.

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

@HyukjinKwon
Copy link
Member

Oh actually we should add it into python/docs/source/reference/pyspark.ml.rst now. I know another missing one. Let me push it to here and just merge.

@HyukjinKwon HyukjinKwon changed the title [MINOR][DOCS] Add KMeansSummary to pyspark clustering.py exports [MINOR][DOCS] Add KMeansSummary and InheritableThread to documentation Aug 19, 2020
@HyukjinKwon
Copy link
Member

Merged to master.

@HyukjinKwon
Copy link
Member

BTW your new profile pic looks nice @srowen!

@SparkQA
Copy link

SparkQA commented Aug 19, 2020

Test build #127621 has finished for PR 29470 at commit d9933b7.

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

@srowen srowen deleted the KMeansSummary branch September 12, 2020 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments