Skip to content

[SPARK-55725][K8S][DOCS] Make AbstractPodsAllocator docs up-to-date#54526

Closed
dongjoon-hyun wants to merge 1 commit intoapache:masterfrom
dongjoon-hyun:SPARK-55725
Closed

[SPARK-55725][K8S][DOCS] Make AbstractPodsAllocator docs up-to-date#54526
dongjoon-hyun wants to merge 1 commit intoapache:masterfrom
dongjoon-hyun:SPARK-55725

Conversation

@dongjoon-hyun
Copy link
Member

@dongjoon-hyun dongjoon-hyun commented Feb 27, 2026

What changes were proposed in this pull request?

This PR aims to make AbstractPodsAllocator documentation up-to-date:

  • Use Javadoc style instead of Scaladoc according to the Apache Spark Code Style Guide.
  • Add Since annotation for the class and methods.
  • Update the class documentation with new DeploymentPodsAllocator.
  • Update the method documentation with since tag.

Why are the changes needed?

AbstractPodsAllocator is one of DeveloperApi of the Apache Spark.

Recently, Apache Spark 4.2.0

Does this PR introduce any user-facing change?

No, this changes documentations only.

How was this patch tested?

Manual review.

Was this patch authored or co-authored using generative AI tooling?

Generated-by: Gemini 3.1 Pro (High) on Antigravity

@dongjoon-hyun dongjoon-hyun changed the title [SPARK-55725][DOCS] Add since tag to AbstractPodsAllocator methods [SPARK-55725][DOCS] Make AbstractPodsAllocator docs up-to-date Feb 27, 2026
@dongjoon-hyun dongjoon-hyun changed the title [SPARK-55725][DOCS] Make AbstractPodsAllocator docs up-to-date [SPARK-55725][K8S][DOCS] Make AbstractPodsAllocator docs up-to-date Feb 27, 2026
@DeveloperApi
abstract class AbstractPodsAllocator {
/*
/**
Copy link
Member Author

Choose a reason for hiding this comment

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

Apache Spark uses Javadoc style instead of Scaladoc.

@dongjoon-hyun
Copy link
Member Author

Thank you, @HyukjinKwon . Merged to master.

@dongjoon-hyun dongjoon-hyun deleted the SPARK-55725 branch February 27, 2026 02:05
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.

2 participants