Skip to content

Comments

Docs: Add informational properties section for table comment#15367

Open
yguy-ryft wants to merge 2 commits intoapache:mainfrom
yguy-ryft:docs-informational-properties
Open

Docs: Add informational properties section for table comment#15367
yguy-ryft wants to merge 2 commits intoapache:mainfrom
yguy-ryft:docs-informational-properties

Conversation

@yguy-ryft
Copy link
Contributor

@yguy-ryft yguy-ryft commented Feb 19, 2026

  • Adds a new "Informational properties" section to the table properties documentation
  • Documents the comment property, which engines like Spark and Flink set via COMMENT in CREATE TABLE DDL
  • This follows a discussion on the dev mailing list about standardizing documentation for properties like comment that provide semantic context about a table - https://lists.apache.org/thread/5q92y3dlnc3mb5b2cj72hzs6xmy3xtfl
  • Ran locally and the section was rendered properly:
image

@github-actions github-actions bot added the docs label Feb 19, 2026
Updated the description of informational properties and the comment property for clarity.
@yguy-ryft yguy-ryft requested a review from stevenzwu February 22, 2026 16:31
@yguy-ryft
Copy link
Contributor Author

@stevenzwu your suggestions were great, I replaced the texts with them - thanks!

Copy link
Contributor

@singhpk234 singhpk234 left a comment

Choose a reason for hiding this comment

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

LGTM too !

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.

5 participants