Skip to content

[SPARK-48828][DOCS] Update documentation to add column as alias of col#47244

Closed
thomhart31 wants to merge 2 commits intoapache:masterfrom
thomhart31:docs-col
Closed

[SPARK-48828][DOCS] Update documentation to add column as alias of col#47244
thomhart31 wants to merge 2 commits intoapache:masterfrom
thomhart31:docs-col

Conversation

@thomhart31
Copy link
Contributor

What changes were proposed in this pull request?

This PR updates the col docstring to indicate that col is an alias of column.

Why are the changes needed?

To improve clarity in documentation.

Does this PR introduce any user-facing change?

No changes in behavior are introduced.

How was this patch tested?

Existing tests.

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

No.

c Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

@thomhart31, this seems to be the wrong file pushed :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@allisonwang-db Good catch. Deleted

@yaooqinn yaooqinn changed the title [SPARK-48828][DOCS][MINOR] Update documentation to add column as alias of col [SPARK-48828][DOCS] Update documentation to add column as alias of col Jul 10, 2024
@yaooqinn
Copy link
Member

Hi @thomhart31 The use of MINOR and JIRA ID in the PR title is mutually exclusive.

def col(col: str) -> Column:
"""
Returns a :class:`~pyspark.sql.Column` based on the given column name.
An alias of :func:`column`.
Copy link
Member

Choose a reason for hiding this comment

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

If you'd like to do this, you should better create the dedicated docstring for column, and say column is an alias.

@github-actions
Copy link

We're closing this PR because it hasn't been updated in a while. This isn't a judgement on the merit of the PR in any way. It's just a way of keeping the PR queue manageable.
If you'd like to revive this PR, please reopen it and ask a committer to remove the Stale tag!

@github-actions github-actions bot added the Stale label Oct 20, 2024
@github-actions github-actions bot closed this Oct 21, 2024
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.

5 participants