Skip to content

Minor: Improve ListingTable documentation#10854

Merged
alamb merged 2 commits intoapache:mainfrom
alamb:alamb/listing_table_docs2
Jun 11, 2024
Merged

Minor: Improve ListingTable documentation#10854
alamb merged 2 commits intoapache:mainfrom
alamb:alamb/listing_table_docs2

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Jun 10, 2024

Which issue does this PR close?

Follow on to #10693

Rationale for this change

@houqp added a great feaure in #10693 that I wanted to make sure was documented

Also, as I am working on #10481 I found I had to explain what LIstingTable was so already had a good example

What changes are included in this PR?

Improve docstrings and example of ListingTable

Are these changes tested?

Doc CI check

Are there any user-facing changes?

Documentation, no functional changes

@github-actions github-actions bot added the core Core DataFusion crate label Jun 10, 2024
@alamb alamb marked this pull request as ready for review June 10, 2024 22:01
Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

lgtm thanks @alamb

Co-authored-by: Oleks V <comphead@users.noreply.github.com>
@alamb alamb merged commit c50f0dc into apache:main Jun 11, 2024
@alamb
Copy link
Contributor Author

alamb commented Jun 11, 2024

Thanks again for the review @comphead

findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
* Minor: Improve ListingTable documentation

* Update datafusion/core/src/datasource/listing/table.rs

Co-authored-by: Oleks V <comphead@users.noreply.github.com>

---------

Co-authored-by: Oleks V <comphead@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Core DataFusion crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants