Skip to content

docs: Fix broken links#16839

Merged
comphead merged 1 commit into
apache:mainfrom
2010YOUY01:ci-deadlinks
Jul 21, 2025
Merged

docs: Fix broken links#16839
comphead merged 1 commit into
apache:mainfrom
2010YOUY01:ci-deadlinks

Conversation

@2010YOUY01

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

  • Closes #.

Rationale for this change

After reviewing #16830, I was trying to setup a CI with cargo-deadlinks to auto-detect broken links in the doc comments.
However, I found it a bit tricky, so in this PR I'm fixing some known broken links. I'll also open an issue to set up such a CI check and try to address it later.

What changes are included in this PR?

Fix broken links in CI

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions Bot added datasource Changes to the datasource crate physical-plan Changes to the physical-plan crate labels Jul 21, 2025
@jcsherin

Copy link
Copy Markdown
Contributor

I've confirmed the URLs you fixed were returning 404. I used the lychee cli link checker which flagged them with a 404 Not Found error.

Unlike cargo-deadlinks, lychee works on the generated Rust docs in target/doc directory and cannot directly inspect the Rust code.

It also flagged two URLs in sqlparser crate.

  1. https://docs.rs/sqlparser/latest/src/sqlparser/dialect/duckdb.rs.html#68
    /// See <https://duckdb.org/docs/sql/functions/lambda.html>
    fn supports_lambda_functions(&self) -> bool {
        true
    }

Fix: https://duckdb.org/docs/stable/sql/functions/lambda

  1. https://docs.rs/sqlparser/latest/src/sqlparser/ast/ddl.rs.html#149
    /// `ATTACH PART|PARTITION <partition_expr>`
    /// Note: this is a ClickHouse-specific operation, please refer to
    /// [ClickHouse](https://clickhouse.com/docs/en/sql-reference/statements/alter/pakrtition#attach-partitionpart)
    AttachPartition {
        // PART is not a short form of PARTITION, it's a separate keyword
        // which represents a physical file on disk and partition is a logical entity.
        partition: Partition,
    },

Fix: https://clickhouse.com/docs/sql-reference/statements/alter/partition#attach-partitionpart

/// [`table_partition_cols`]: https://github.com/apache/datafusion/blob/main/datafusion/core/src/datasource/file_format/options.rs#L190
/// [`wrap_partition_type_in_dict`]: crate::file_scan_config::wrap_partition_type_in_dict
/// [`wrap_partition_value_in_dict`]: crate::file_scan_config::wrap_partition_value_in_dict
/// [`table_partition_cols`]: https://github.com/apache/datafusion/blob/main/datafusion/core/src/datasource/file_format/options.rs#L87

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.

👍

@alamb alamb 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 @2010YOUY01 and @jcsherin

@alamb alamb added the documentation Improvements or additions to documentation label Jul 21, 2025
@comphead
comphead merged commit c74fcaf into apache:main Jul 21, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

datasource Changes to the datasource crate documentation Improvements or additions to documentation physical-plan Changes to the physical-plan crate

4 participants