Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix docstring of set_table_properties #2820

Merged
merged 2 commits into from
Aug 23, 2024

Conversation

astrojuanlu
Copy link
Contributor

Description

The docstring wasn't rendering properly, see https://delta-io.github.io/delta-rs/api/delta_table/delta_table_alterer/#deltalake.table.TableAlterer.set_table_properties, so I think I fixed the syntax (I haven't tested it locally, does the CI build the docs?) and I also added an example (mostly taken from another docstring +

def test_set_table_properties_enable_cdf(
tmp_path: pathlib.Path, sample_table: pa.Table
):
write_deltalake(tmp_path, sample_table, mode="append", engine="rust")
dt = DeltaTable(tmp_path)
dt.alter.set_table_properties({"delta.enableChangeDataFeed": "true"})
)

Related Issue(s)

Documentation

@github-actions github-actions bot added the binding/python Issues for the Python package label Aug 23, 2024
Copy link

ACTION NEEDED

delta-rs follows the Conventional Commits specification for release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

@astrojuanlu astrojuanlu changed the title Fix docstring of set_table_properties docs: fix docstring of set_table_properties Aug 23, 2024
Copy link
Collaborator

@ion-elgreco ion-elgreco left a comment

Choose a reason for hiding this comment

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

Thanks!

@ion-elgreco ion-elgreco added this pull request to the merge queue Aug 23, 2024
Merged via the queue into delta-io:main with commit 23feb52 Aug 23, 2024
22 of 23 checks passed
@astrojuanlu astrojuanlu deleted the patch-1 branch August 23, 2024 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
binding/python Issues for the Python package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants