[Parquet Metadata Cache] Document the ListingTable cache #17133
Conversation
jonathanc-n
left a comment
There was a problem hiding this comment.
This lgtm, some very minor comments, gets all the points across to users. @nuno-faria can probably add some deeper insight
Co-authored-by: Nuno Faria <nunofpfaria@gmail.com> Co-authored-by: Jonathan Chen <chenleejonathan@gmail.com>
| /// Recently Used eviction algorithm. | ||
| /// Create a new instance of [`DefaultFilesMetadataCache`]. | ||
| /// | ||
| /// # Arguments |
There was a problem hiding this comment.
I found 2 another places where arguments highlighted like this whereas other functions describe arguments in free style. Just thinking aloud
There was a problem hiding this comment.
Yeah, I agree the docs are inconsistent in this regard.
I personally think that a whole section is only really useful when the arguments are non obvious or there is some nuance to them (such as this case). However, that is a subjective judgement call for sure
I think it would not add much clarity if we, for example, added an # Arguments section for all functions, though I do think this is what is done in some other projects
|
🚀 I am trying to close out some tickets on Friday so merging this to start the weekend on a high note Thanks for the reviews everyone |
Which issue does this PR close?
Rationale for this change
As explained on the ticket
What changes are included in this PR?
Revamp and extend documentation for
LIstingTableand the various CacheManager structuresAre these changes tested?
By Docs ci
Are there any user-facing changes?
Better docs. No function changes intended