Skip to content
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

Docs: Improve readability on page Branching and Tagging #7592

Merged
merged 2 commits into from
May 15, 2023

Conversation

zhangbutao
Copy link
Contributor

@zhangbutao zhangbutao commented May 12, 2023

Improve readability on the page: https://iceberg.apache.org/docs/latest/branching/

@github-actions github-actions bot added the docs label May 12, 2023
@@ -30,7 +30,7 @@ menu:

## Overview

Iceberg table metadata maintains a log of snapshots which represent the changes applied to a table.
Iceberg table metadata maintains a lot of snapshots which represent the changes applied to a table.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure this is a typo, I think this actually means that it's holding a snapshot log. To make this clearer maybe reword this to Iceberg table metadata maintains a snapshot log, which represent the changes applied to a table.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nastra Thanks for clarification. It seems that i misunderstood the sentence. :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah it's a log of snapshots, but I like @nastra suggestion, we can use "snapshot log" so it's more clear. thanks @zhangbutao !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I made a little change on this sentence according your guys suggestion. Thanks.

@zhangbutao zhangbutao changed the title Docs: Fix typo on page Branching and Tagging Docs: Improve readability on page Branching and Tagging May 14, 2023
Copy link
Contributor

@nastra nastra 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 @zhangbutao.

@amogh-jahagirdar
Copy link
Contributor

amogh-jahagirdar commented May 15, 2023

Looks great, thanks @zhangbutao ! Merging

@amogh-jahagirdar amogh-jahagirdar merged commit 1144241 into apache:master May 15, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants