Skip to content

docs: fix references in public docs - #2937

Open
JosephLenton wants to merge 4 commits into
apache:mainfrom
JosephLenton:fix-doc-links
Open

docs: fix references in public docs#2937
JosephLenton wants to merge 4 commits into
apache:mainfrom
JosephLenton:fix-doc-links

Conversation

@JosephLenton

@JosephLenton JosephLenton commented Jul 31, 2026

Copy link
Copy Markdown

Which issue does this PR close?

What changes are included in this PR?

  • Links to external sites are made clickable. This is changing from https://example.com to <https://example.com>.
  • References to internal APIs are removed. The comment is the same, but the doc link is gone.
  • Trailing triple slash opening a code snippet, but never closing it, are removed.

The following items were previously mentioned in the docs, but were not public. They are now publicaly exported:

iceberg::transaction::ExpireSnapshotsAction
iceberg::transaction::FastAppendAction
iceberg::transaction::ReplaceSortOrderAction
iceberg::transaction::UpdateLocationAction
iceberg::transaction::UpdatePropertiesAction
iceberg::transaction::UpdateSchemaAction
iceberg::transaction::UpdateStatisticsAction
iceberg::transaction::UpgradeFormatVersionAction
iceberg::transaction::TransactionAction
iceberg::JoinHandle

Are these changes tested?

These changes were QA'd by running cargo doc --no-deps.

AI Disclosure

I got Claude to do most of the changes in this PR.

@JosephLenton
JosephLenton marked this pull request as ready for review July 31, 2026 22:02

@dannycjones dannycjones left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this change, @JosephLenton! I think it's important that we maintain good hygiene on the docs.

I think there's a few things highlighted by the lints where we're better addressing the root cause. For example: types that we thought were public but actually aren't, and need exporting.

Comment thread crates/iceberg/src/runtime/mod.rs
Comment thread crates/iceberg/src/spec/schema/mod.rs
Comment thread crates/iceberg/src/spec/table_metadata.rs Outdated
Comment thread crates/iceberg/src/transaction/update_schema.rs Outdated
@JosephLenton

Copy link
Copy Markdown
Author

Hey @dannycjones I have updated the PR to now export all of the bits I could find, and made further updates to the docs.

When you get time could you please give this a second review.

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.

Fix current docs build issues

2 participants