Rafferty97 commented on PR #11694:
URL: https://github.com/apache/datafusion/pull/11694#issuecomment-2254729045
It looks like `cargo doc` failed with this error:
```
error: unresolved link to `r`
--> datafusion/functions/src/macros.rs:78:17
|
78 | #[doc = concat!("Return a
[`ScalarUDF`](datafusion_expr::ScalarUDF) for [`", stringify!($UDF), "`]")]
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
::: datafusion/functions/src/core/mod.rs:41:1
|
41 | make_udf_function!(r#struct::StructFunc, STRUCT, r#struct);
| ---------------------------------------------------------- in this
macro invocation
|
= note: the link appears in this line:
Return a [`ScalarUDF`](datafusion_expr::ScalarUDF) for
[`r#struct::StructFunc`]
^^^^^^^^^^^^^^^^^^^^^^
= note: no item named `r` in scope
= help: to escape `[` and `]` characters, add '\' before them like `\[`
or `\]`
= note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
= help: to override `-D warnings` add
`#[allow(rustdoc::broken_intra_doc_links)]`
= note: this error originates in the macro `make_udf_function` (in
Nightly builds, run with -Z macro-backtrace for more info)
```
I've investigated it but I can't figure out why this is occurring (other
than the raw identifier clearly being an issue) or how to remediate it. If I
type out the same doc string manually, like so:
```
/// Return a [`ScalarUDF`](datafusion_expr::ScalarUDF) for
[`r#struct::StructFunc`]
pub fn foo() {}
```
and run `cargo doc` locally, it works exactly as expected.
--
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]
