chakkk309 commented on code in PR #19068:
URL: https://github.com/apache/datafusion/pull/19068#discussion_r2587093113
##########
datafusion/doc/src/lib.rs:
##########
@@ -30,7 +30,7 @@ pub use udaf::aggregate_doc_sections;
pub use udf::scalar_doc_sections;
pub use udwf::window_doc_sections;
-#[allow(rustdoc::broken_intra_doc_links)]
+#[expect(rustdoc::broken_intra_doc_links)]
Review Comment:
Hi, I've identified 2 options to address the
#[expect(rustdoc::broken_intra_doc_links)] in datafusion-doc/src/lib.rs. Since
datafusion-doc is designed as an independent crate without dependencies on
other DataFusion crates, the original intra-doc links like
[ScalarUDFImpl](ScalarUDFImpl) cannot be resolved.
Option 1: Simple code references
```
/// Documentation for use by `ScalarUDFImpl`, `AggregateUDFImpl` and
`WindowUDFImpl` functions.`
```
Option 2: External links to docs.rs
```
/// Documentation for use by [`ScalarUDFImpl`], [`AggregateUDFImpl`] and
[`WindowUDFImpl`] functions.
///
/// [`ScalarUDFImpl`]:
https://docs.rs/datafusion-expr/latest/datafusion_expr/trait.ScalarUDFImpl.html
/// [`AggregateUDFImpl`]:
https://docs.rs/datafusion-expr/latest/datafusion_expr/trait.AggregateUDFImpl.html
/// [`WindowUDFImpl`]:
https://docs.rs/datafusion-expr/latest/datafusion_expr/trait.WindowUDFImpl.html
```
Which kind of method would we prefer for this use case?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
