-
Notifications
You must be signed in to change notification settings - Fork 2.5k
[MINOR] Improve documentation of org.apache.hudi.common.table.view.AbstractTableFileSystemView #8585
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
Conversation
…tractTableFileSystemView(apache#8585)
| * views based on that (c) Thread-safety in loading and managing file system views for this table. (d) resetting | ||
| * file-system views The actual mechanism of fetching file slices from different view storages is delegated to | ||
| * Common thread-safe implementation for multiple TableFileSystemView Implementations. <br>Provides uniform handling of: <br>(a) | ||
| * Loading file-system views from underlying file-system <br>(b) Pending compaction operations and changing file-system |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe a <ul> list makes more sense here? The structure is:
<ul>
<li></li>
<li></li>
...
</ul>There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's true. I made some changes
…tractTableFileSystemView with list item tag(apache#8585)
| * <ul> | ||
| * <li>Loading file-system views from underlying file-system</li> | ||
| * <li>Pending compaction operations and changing file-system views based on that</li> | ||
| * <li>Thread-safety in loading and managing file system views for this table</li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For each of the item, end it with ;, and for the last item, end with ..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, thanks for your guidance
…tractTableFileSystemView,For each of the item, end it with ;, and for the last item, end with ..(apache#8585)
|
this kind of docs update does not require CI. will just merge it. |
Should be caution with the checkstyle error. |
…stractTableFileSystemView (apache#8585)
…stractTableFileSystemView (apache#8585)
…stractTableFileSystemView (apache#8585)
…actTableFileSystemView
Change Logs
This PR improved org.apache.hudi.common.table.view.AbstractTableFileSystemView header comments
Impact
Add the br tag to make it easier for users to understand
Risk level (write none, low medium or high below)
none
Documentation Update
none
Contributor's checklist