Improve parquet WriterProperites and ReaderProperties docs
#4392
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alamb
commented
Jun 9, 2023
| @@ -15,55 +15,7 @@ | |||
| // specific language governing permissions and limitations | |||
| // under the License. | |||
|
|
|||
| //! [`WriterProperties`] | |||
There was a problem hiding this comment.
I moved the examples to the WriterProperties and ReaderProperties so they would be easier to find
I think the module level docs now look pretty clear:
| /// Default value for [`WriterProperties::dictionary_page_size_limit`] | ||
| pub const DEFAULT_DICTIONARY_PAGE_SIZE_LIMIT: usize = DEFAULT_PAGE_SIZE; | ||
| /// Default value for [`WriterProperties::statistics_enabled`] | ||
| pub const DEFAULT_STATISTICS_ENABLED: EnabledStatistics = EnabledStatistics::Page; |
There was a problem hiding this comment.
This is what I was looking for, but since the value was not pub it wasn't in the rustdocs
I could have included the value in the text of WriterProperties::statistics_enabled but thought that this way was less likely to get out of sync
tustvold
approved these changes
Jun 9, 2023
wjones127
approved these changes
Jun 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
N/A
Rationale for this change
I was checking how the parquet writer was configured in IOx and it took me some digging to see what statistics were enabled by default. It would have been nice to avoid that digging
What changes are included in this PR?
puband document themAre there any user-facing changes?