[doc] Fix broken URLs #3486
[doc] Fix broken URLs #3486
Conversation
Use proper syntax when [linking to items by name]. Before: https://docs.rs/arrow-array/latest/arrow_array/iterator/%5Bcrate::PrimitiveArray%5D After: https://docs.rs/arrow-array/latest/arrow_array/array/struct.PrimitiveArray.html [linking to items by name]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html
github-actions
bot
added
arrow
arrow-array/src/types.rs
Outdated
| /// [`DecimalArray`]: [crate::array::DecimalArray] | ||
| /// [`Decimal128Array`]: [crate::array::Decimal128Array] | ||
| /// [`Decimal256Array`]: [crate::array::Decimal256Array] | ||
| /// [`DecimalArray`]: crate::array::DecimalArray |
There was a problem hiding this comment.
CI is unhappy, for there is no such identifier.
error: unresolved link to `crate::array::DecimalArray`
--> arrow-array/src/types.rs:568:23
|
568 | /// [`DecimalArray`]: crate::array::DecimalArray
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `DecimalArray` in module `array`
error: could not document `arrow-array`
Should it be PrimitiveArray?
I found #2637, it seems to be related...
arrow-array: - `DecimalArray` is undefined. Use `PrimitiveArray` instead. - `arrow` crate is not among `arrow-array`'s dependencies, so its items cannot be referred to using ['intra-doc link'] syntax. ['intra-doc link']: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html
| /// [`compute::unary`]: https://docs.rs/arrow/latest/arrow/compute/fn.unary.html | ||
| /// [`compute::try_unary`]: https://docs.rs/arrow/latest/arrow/compute/fn.try_unary.html |
There was a problem hiding this comment.
arrow crate is not among arrow-array's dependencies, so its items cannot be referred to using ‘intra-doc link’ syntax.
| /// A trait over the decimal types, used by [`DecimalArray`] to provide a generic | ||
| /// A trait over the decimal types, used by [`PrimitiveArray`] to provide a generic |
There was a problem hiding this comment.
@tustvold Is this change correct?
|
Benchmark runs are scheduled for baseline = c28d69a and contender = 8492c27. 8492c27 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Use proper syntax when linking to items by name.
Before:
https://docs.rs/arrow-array/latest/arrow_array/iterator/%5Bcrate::PrimitiveArray%5D
After:
https://docs.rs/arrow-array/latest/arrow_array/array/struct.PrimitiveArray.html