Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] Fix broken URLs #3486

Merged
merged 2 commits into from Jan 7, 2023
Merged

[doc] Fix broken URLs #3486

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8717ac6
[doc] Fix broken URLs
vvv Jan 7, 2023
6fc5ed3
[doc] Use proper identifiers
vvv Jan 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions arrow-array/src/iterator.rs
View file
Open in desktop
Expand Up @@ -39,9 +39,9 @@ use crate::array::{
/// there are more efficient ways to iterate over just the non-null indices, this functionality
/// is provided by [`compute::try_unary`]
///
/// [`PrimitiveArray`]: [crate::PrimitiveArray]
/// [`compute::unary`]: [arrow::compute::unary]
/// [`compute::try_unary`]: [arrow::compute::try_unary]
/// [`PrimitiveArray`]: crate::PrimitiveArray
/// [`compute::unary`]: arrow::compute::unary
/// [`compute::try_unary`]: arrow::compute::try_unary
#[derive(Debug)]
pub struct ArrayIter<T: ArrayAccessor> {
array: T,
Expand Down
6 changes: 3 additions & 3 deletions arrow-array/src/types.rs
View file
Open in desktop
Expand Up @@ -565,9 +565,9 @@ mod decimal {
/// Implemented by [`Decimal128Type`] and [`Decimal256Type`] for [`Decimal128Array`]
/// and [`Decimal256Array`] respectively
///
/// [`DecimalArray`]: [crate::array::DecimalArray]
/// [`Decimal128Array`]: [crate::array::Decimal128Array]
/// [`Decimal256Array`]: [crate::array::Decimal256Array]
/// [`DecimalArray`]: crate::array::DecimalArray
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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...

/// [`Decimal128Array`]: crate::array::Decimal128Array
/// [`Decimal256Array`]: crate::array::Decimal256Array
pub trait DecimalType:
'static + Send + Sync + ArrowPrimitiveType + decimal::DecimalTypeSealed
{
Expand Down
4 changes: 2 additions & 2 deletions object_store/src/aws/mod.rs
View file
Open in desktop
Expand Up @@ -814,8 +814,8 @@ impl AmazonS3Builder {
///
/// This option has no effect if not using instance credentials
///
/// [IMDSv2]: [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html]
/// [SSRF attack]: [https://aws.amazon.com/blogs/security/defense-in-depth-open-firewalls-reverse-proxies-ssrf-vulnerabilities-ec2-instance-metadata-service/]
/// [IMDSv2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html
/// [SSRF attack]: https://aws.amazon.com/blogs/security/defense-in-depth-open-firewalls-reverse-proxies-ssrf-vulnerabilities-ec2-instance-metadata-service/
///
pub fn with_imdsv1_fallback(mut self) -> Self {
self.imdsv1_fallback = true;
Expand Down
2 changes: 1 addition & 1 deletion parquet/src/arrow/arrow_reader/filter.rs
View file
Open in desktop
Expand Up @@ -94,7 +94,7 @@ where
/// leaves 99% of the rows, it may be better to not filter the data from parquet and
/// apply the filter after the RecordBatch has been fully decoded.
///
/// [`RowSelection`]: [super::selection::RowSelection]
/// [`RowSelection`]: crate::arrow::arrow_reader::RowSelection
pub struct RowFilter {
/// A list of [`ArrowPredicate`]
pub(crate) predicates: Vec<Box<dyn ArrowPredicate>>,
Expand Down
6 changes: 3 additions & 3 deletions parquet/src/arrow/arrow_reader/mod.rs
View file
Open in desktop
Expand Up @@ -50,7 +50,7 @@ pub use selection::{RowSelection, RowSelector};
/// * For a synchronous API - [`ParquetRecordBatchReaderBuilder`]
/// * For an asynchronous API - [`ParquetRecordBatchStreamBuilder`]
///
/// [`ParquetRecordBatchStreamBuilder`]: [crate::arrow::async_reader::ParquetRecordBatchStreamBuilder]
/// [`ParquetRecordBatchStreamBuilder`]: crate::arrow::async_reader::ParquetRecordBatchStreamBuilder
pub struct ArrowReaderBuilder<T> {
pub(crate) input: T,

Expand Down Expand Up @@ -150,7 +150,7 @@ impl<T> ArrowReaderBuilder<T> {
/// An example use case of this would be applying a selection determined by
/// evaluating predicates against the [`Index`]
///
/// [`Index`]: [parquet::file::page_index::index::Index]
/// [`Index`]: crate::file::page_index::index::Index
pub fn with_row_selection(self, selection: RowSelection) -> Self {
Self {
selection: Some(selection),
Expand Down Expand Up @@ -238,7 +238,7 @@ impl ArrowReaderOptions {
/// Set this true to enable decoding of the [PageIndex] if present. This can be used
/// to push down predicates to the parquet scan, potentially eliminating unnecessary IO
///
/// [PageIndex]: [https://github.com/apache/parquet-format/blob/master/PageIndex.md]
/// [PageIndex]: https://github.com/apache/parquet-format/blob/master/PageIndex.md
pub fn with_page_index(self, page_index: bool) -> Self {
Self { page_index, ..self }
}
Expand Down
2 changes: 1 addition & 1 deletion parquet/src/arrow/arrow_reader/selection.rs
View file
Open in desktop
Expand Up @@ -83,7 +83,7 @@ impl RowSelector {
/// assert_eq!(actual, expected);
/// ```
///
/// [`PageIndex`]: [crate::file::page_index::index::PageIndex]
/// [`PageIndex`]: crate::file::page_index::index::PageIndex
#[derive(Debug, Clone, Default, Eq, PartialEq)]
pub struct RowSelection {
selectors: Vec<RowSelector>,
Expand Down