Skip to content

Conversation

@Paddy0523
Copy link
Contributor

…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

  • Read through contributor's guide
  • Change Logs and Impact were stated clearly
  • Adequate tests were added if applicable
  • CI passed

@Paddy0523 Paddy0523 changed the title [DOC]Improve documentation of org.apache.hudi.common.table.view.Abstr… [HUDI-8585]Improve documentation of org.apache.hudi.common.table.view.Abstr… Apr 27, 2023
@Paddy0523 Paddy0523 changed the title [HUDI-8585]Improve documentation of org.apache.hudi.common.table.view.Abstr… [DOC]Improve documentation of org.apache.hudi.common.table.view.Abstr… Apr 27, 2023
* 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
Copy link
Contributor

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>

Copy link
Contributor Author

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

* <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>
Copy link
Contributor

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 ..

Copy link
Contributor Author

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)
@danny0405 danny0405 changed the title [DOC]Improve documentation of org.apache.hudi.common.table.view.Abstr… [MINOR] Improve documentation of org.apache.hudi.common.table.view.AbstractTableFileSystemView May 4, 2023
@hudi-bot
Copy link
Collaborator

hudi-bot commented May 4, 2023

CI report:

Bot commands @hudi-bot supports the following commands:
  • @hudi-bot run azure re-run the last Azure build

@xushiyan
Copy link
Member

xushiyan commented May 4, 2023

this kind of docs update does not require CI. will just merge it.

@xushiyan xushiyan merged commit 84ab77c into apache:master May 4, 2023
@danny0405
Copy link
Contributor

this kind of docs update does not require CI. will just merge it.

Should be caution with the checkstyle error.

yihua pushed a commit to yihua/hudi that referenced this pull request May 15, 2023
yihua pushed a commit to yihua/hudi that referenced this pull request May 15, 2023
yihua pushed a commit to yihua/hudi that referenced this pull request May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants