This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new 23db567d05 Cleanup redundant link targets (#4719)
23db567d05 is described below
commit 23db567d05bc21df56f5f7d08288f209de9fd785
Author: Raphael Taylor-Davies <[email protected]>
AuthorDate: Mon Aug 21 14:07:32 2023 +0100
Cleanup redundant link targets (#4719)
---
arrow-array/src/array/fixed_size_list_array.rs | 3 +--
arrow-array/src/array/list_array.rs | 3 +--
arrow-array/src/array/mod.rs | 4 ++--
arrow-array/src/record_batch.rs | 2 +-
arrow-flight/src/client.rs | 12 +++++-----
arrow-flight/src/encode.rs | 4 ++--
arrow/src/datatypes/mod.rs | 6 ++---
arrow/src/lib.rs | 2 +-
parquet/src/column/page.rs | 6 ++---
parquet/src/file/serialized_reader.rs | 2 +-
parquet/src/record/reader.rs | 19 +++++++--------
parquet/src/schema/parser.rs | 4 ++--
parquet/src/schema/printer.rs | 8 +++----
parquet/src/schema/types.rs | 33 +++++++++++++-------------
14 files changed, 51 insertions(+), 57 deletions(-)
diff --git a/arrow-array/src/array/fixed_size_list_array.rs
b/arrow-array/src/array/fixed_size_list_array.rs
index 8996fc8da4..db3ccbe061 100644
--- a/arrow-array/src/array/fixed_size_list_array.rs
+++ b/arrow-array/src/array/fixed_size_list_array.rs
@@ -32,8 +32,7 @@ use std::sync::Arc;
/// Lists are represented using a `values` child
/// array where each list has a fixed size of `value_length`.
///
-/// Use [`FixedSizeListBuilder`](crate::builder::FixedSizeListBuilder) to
-/// construct a [`FixedSizeListArray`].
+/// Use [`FixedSizeListBuilder`] to construct a [`FixedSizeListArray`].
///
/// # Representation
///
diff --git a/arrow-array/src/array/list_array.rs
b/arrow-array/src/array/list_array.rs
index 3508e4f1c4..e36d0ac443 100644
--- a/arrow-array/src/array/list_array.rs
+++ b/arrow-array/src/array/list_array.rs
@@ -64,8 +64,7 @@ impl OffsetSizeTrait for i64 {
/// Arrow defines [`ListArray`] with `i32` offsets and
/// [`LargeListArray`] with `i64` offsets.
///
-/// Use [`GenericListBuilder`](crate::builder::GenericListBuilder) to
-/// construct a [`GenericListArray`].
+/// Use [`GenericListBuilder`] to construct a [`GenericListArray`].
///
/// # Representation
///
diff --git a/arrow-array/src/array/mod.rs b/arrow-array/src/array/mod.rs
index 79240d105a..905ec1e543 100644
--- a/arrow-array/src/array/mod.rs
+++ b/arrow-array/src/array/mod.rs
@@ -69,7 +69,7 @@ pub use run_array::*;
/// An array in the [arrow columnar
format](https://arrow.apache.org/docs/format/Columnar.html)
pub trait Array: std::fmt::Debug + Send + Sync {
- /// Returns the array as [`Any`](std::any::Any) so that it can be
+ /// Returns the array as [`Any`] so that it can be
/// downcasted to a specific implementation.
///
/// # Example:
@@ -101,7 +101,7 @@ pub trait Array: std::fmt::Debug + Send + Sync {
/// Unlike [`Array::to_data`] this consumes self, allowing it avoid
unnecessary clones
fn into_data(self) -> ArrayData;
- /// Returns a reference to the [`DataType`](arrow_schema::DataType) of
this array.
+ /// Returns a reference to the [`DataType`] of this array.
///
/// # Example:
///
diff --git a/arrow-array/src/record_batch.rs b/arrow-array/src/record_batch.rs
index 80c0e4b967..886d00e0c2 100644
--- a/arrow-array/src/record_batch.rs
+++ b/arrow-array/src/record_batch.rs
@@ -238,7 +238,7 @@ impl RecordBatch {
})
}
- /// Returns the [`Schema`](arrow_schema::Schema) of the record batch.
+ /// Returns the [`Schema`] of the record batch.
pub fn schema(&self) -> SchemaRef {
self.schema.clone()
}
diff --git a/arrow-flight/src/client.rs b/arrow-flight/src/client.rs
index f843bbf7cd..2c952fb3bf 100644
--- a/arrow-flight/src/client.rs
+++ b/arrow-flight/src/client.rs
@@ -74,7 +74,7 @@ pub struct FlightClient {
}
impl FlightClient {
- /// Creates a client client with the provided
[`Channel`](tonic::transport::Channel)
+ /// Creates a client client with the provided [`Channel`]
pub fn new(channel: Channel) -> Self {
Self::new_from_inner(FlightServiceClient::new(channel))
}
@@ -262,7 +262,7 @@ impl FlightClient {
}
/// Make a `DoPut` call to the server with the provided
- /// [`Stream`](futures::Stream) of [`FlightData`] and returning a
+ /// [`Stream`] of [`FlightData`] and returning a
/// stream of [`PutResult`].
///
/// # Note
@@ -340,7 +340,7 @@ impl FlightClient {
}
/// Make a `DoExchange` call to the server with the provided
- /// [`Stream`](futures::Stream) of [`FlightData`] and returning a
+ /// [`Stream`] of [`FlightData`] and returning a
/// stream of [`FlightData`].
///
/// # Example:
@@ -391,7 +391,7 @@ impl FlightClient {
}
/// Make a `ListFlights` call to the server with the provided
- /// criteria and returning a [`Stream`](futures::Stream) of [`FlightInfo`].
+ /// criteria and returning a [`Stream`] of [`FlightInfo`].
///
/// # Example:
/// ```no_run
@@ -469,7 +469,7 @@ impl FlightClient {
}
/// Make a `ListActions` call to the server and returning a
- /// [`Stream`](futures::Stream) of [`ActionType`].
+ /// [`Stream`] of [`ActionType`].
///
/// # Example:
/// ```no_run
@@ -506,7 +506,7 @@ impl FlightClient {
}
/// Make a `DoAction` call to the server and returning a
- /// [`Stream`](futures::Stream) of opaque [`Bytes`].
+ /// [`Stream`] of opaque [`Bytes`].
///
/// # Example:
/// ```no_run
diff --git a/arrow-flight/src/encode.rs b/arrow-flight/src/encode.rs
index 9650031d8b..cd2ee7c02b 100644
--- a/arrow-flight/src/encode.rs
+++ b/arrow-flight/src/encode.rs
@@ -24,7 +24,7 @@ use arrow_schema::{DataType, Field, Fields, Schema,
SchemaRef};
use bytes::Bytes;
use futures::{ready, stream::BoxStream, Stream, StreamExt};
-/// Creates a [`Stream`](futures::Stream) of [`FlightData`]s from a
+/// Creates a [`Stream`] of [`FlightData`]s from a
/// `Stream` of [`Result`]<[`RecordBatch`], [`FlightError`]>.
///
/// This can be used to implement [`FlightService::do_get`] in an
@@ -146,7 +146,7 @@ impl FlightDataEncoderBuilder {
self
}
- /// Return a [`Stream`](futures::Stream) of [`FlightData`],
+ /// Return a [`Stream`] of [`FlightData`],
/// consuming self. More details on [`FlightDataEncoder`]
pub fn build<S>(self, input: S) -> FlightDataEncoder
where
diff --git a/arrow/src/datatypes/mod.rs b/arrow/src/datatypes/mod.rs
index 840e98ab0d..bc5b7d500b 100644
--- a/arrow/src/datatypes/mod.rs
+++ b/arrow/src/datatypes/mod.rs
@@ -18,9 +18,9 @@
//! Defines the logical data types of Arrow arrays.
//!
//! The most important things you might be looking for are:
-//! * [`Schema`](crate::datatypes::Schema) to describe a schema.
-//! * [`Field`](crate::datatypes::Field) to describe one field within a
schema.
-//! * [`DataType`](crate::datatypes::DataType) to describe the type of a
field.
+//! * [`Schema`] to describe a schema.
+//! * [`Field`] to describe one field within a schema.
+//! * [`DataType`] to describe the type of a field.
pub use arrow_array::types::*;
pub use arrow_array::{ArrowNativeTypeOp, ArrowNumericType, ArrowPrimitiveType};
diff --git a/arrow/src/lib.rs b/arrow/src/lib.rs
index e347f99ee4..fb904c1908 100644
--- a/arrow/src/lib.rs
+++ b/arrow/src/lib.rs
@@ -160,7 +160,7 @@
//!
//! # Compute Kernels
//!
-//! The [`compute`](compute) module provides optimised implementations of many
common operations,
+//! The [`compute`] module provides optimised implementations of many common
operations,
//! for example the `parse_strings` operation above could also be implemented
as follows:
//!
//! ```
diff --git a/parquet/src/column/page.rs b/parquet/src/column/page.rs
index 654cd08160..ec9af2aa27 100644
--- a/parquet/src/column/page.rs
+++ b/parquet/src/column/page.rs
@@ -58,7 +58,7 @@ pub enum Page {
}
impl Page {
- /// Returns [`PageType`](crate::basic::PageType) for this page.
+ /// Returns [`PageType`] for this page.
pub fn page_type(&self) -> PageType {
match self {
Page::DataPage { .. } => PageType::DATA_PAGE,
@@ -85,7 +85,7 @@ impl Page {
}
}
- /// Returns this page [`Encoding`](crate::basic::Encoding).
+ /// Returns this page [`Encoding`].
pub fn encoding(&self) -> Encoding {
match self {
Page::DataPage { encoding, .. } => *encoding,
@@ -94,7 +94,7 @@ impl Page {
}
}
- /// Returns optional [`Statistics`](crate::file::statistics::Statistics).
+ /// Returns optional [`Statistics`].
pub fn statistics(&self) -> Option<&Statistics> {
match self {
Page::DataPage { ref statistics, .. } => statistics.as_ref(),
diff --git a/parquet/src/file/serialized_reader.rs
b/parquet/src/file/serialized_reader.rs
index 3dac8ee558..8eccf3408a 100644
--- a/parquet/src/file/serialized_reader.rs
+++ b/parquet/src/file/serialized_reader.rs
@@ -76,7 +76,7 @@ impl<'a> TryFrom<&'a str> for SerializedFileReader<File> {
}
}
-/// Conversion into a [`RowIter`](crate::record::reader::RowIter)
+/// Conversion into a [`RowIter`]
/// using the full file schema over all row groups.
impl IntoIterator for SerializedFileReader<File> {
type Item = Result<Row>;
diff --git a/parquet/src/record/reader.rs b/parquet/src/record/reader.rs
index 3416386c97..5a1d840657 100644
--- a/parquet/src/record/reader.rs
+++ b/parquet/src/record/reader.rs
@@ -16,7 +16,7 @@
// under the License.
//! Contains implementation of record assembly and converting Parquet types
into
-//! [`Row`](crate::record::Row)s.
+//! [`Row`]s.
use std::{collections::HashMap, fmt, sync::Arc};
@@ -618,7 +618,7 @@ impl fmt::Display for Reader {
// Row iterators
/// The enum Either with variants That represents a reference and a box of
-/// [`FileReader`](crate::file::reader::FileReader).
+/// [`FileReader`].
enum Either<'a> {
Left(&'a dyn FileReader),
Right(Box<dyn FileReader>),
@@ -633,7 +633,7 @@ impl<'a> Either<'a> {
}
}
-/// Iterator of [`Row`](crate::record::Row)s.
+/// Iterator of [`Row`]s.
/// It is used either for a single row group to iterate over data in that row
group, or
/// an entire file with auto buffering of all row groups.
pub struct RowIter<'a> {
@@ -646,7 +646,7 @@ pub struct RowIter<'a> {
}
impl<'a> RowIter<'a> {
- /// Creates a new iterator of [`Row`](crate::record::Row)s.
+ /// Creates a new iterator of [`Row`]s.
fn new(
file_reader: Option<Either<'a>>,
row_iter: Option<ReaderIter>,
@@ -668,7 +668,7 @@ impl<'a> RowIter<'a> {
}
}
- /// Creates iterator of [`Row`](crate::record::Row)s for all row groups in
a
+ /// Creates iterator of [`Row`]s for all row groups in a
/// file.
pub fn from_file(proj: Option<Type>, reader: &'a dyn FileReader) ->
Result<Self> {
let either = Either::Left(reader);
@@ -680,7 +680,7 @@ impl<'a> RowIter<'a> {
Ok(Self::new(Some(either), None, descr))
}
- /// Creates iterator of [`Row`](crate::record::Row)s for a specific row
group.
+ /// Creates iterator of [`Row`]s for a specific row group.
pub fn from_row_group(
proj: Option<Type>,
reader: &'a dyn RowGroupReader,
@@ -694,8 +694,7 @@ impl<'a> RowIter<'a> {
Ok(Self::new(None, Some(row_iter), descr))
}
- /// Creates a iterator of [`Row`](crate::record::Row)s from a
- /// [`FileReader`](crate::file::reader::FileReader) using the full file
schema.
+ /// Creates a iterator of [`Row`]s from a [`FileReader`] using the full
file schema.
pub fn from_file_into(reader: Box<dyn FileReader>) -> Self {
let either = Either::Right(reader);
let descr = either
@@ -707,7 +706,7 @@ impl<'a> RowIter<'a> {
Self::new(Some(either), None, descr)
}
- /// Tries to create a iterator of [`Row`](crate::record::Row)s using
projections.
+ /// Tries to create a iterator of [`Row`]s using projections.
/// Returns a error if a file reader is not the source of this iterator.
///
/// The Projected schema can be a subset of or equal to the file schema,
@@ -793,7 +792,7 @@ impl<'a> Iterator for RowIter<'a> {
}
}
-/// Internal iterator of [`Row`](crate::record::Row)s for a reader.
+/// Internal iterator of [`Row`]s for a reader.
pub struct ReaderIter {
root_reader: Reader,
records_left: usize,
diff --git a/parquet/src/schema/parser.rs b/parquet/src/schema/parser.rs
index 9af0f328a7..d589f8c110 100644
--- a/parquet/src/schema/parser.rs
+++ b/parquet/src/schema/parser.rs
@@ -17,7 +17,7 @@
//! Parquet schema parser.
//! Provides methods to parse and validate string message type into Parquet
-//! [`Type`](crate::schema::types::Type).
+//! [`Type`].
//!
//! # Example
//!
@@ -50,7 +50,7 @@ use crate::basic::{
use crate::errors::{ParquetError, Result};
use crate::schema::types::{Type, TypePtr};
-/// Parses message type as string into a Parquet
[`Type`](crate::schema::types::Type)
+/// Parses message type as string into a Parquet [`Type`]
/// which, for example, could be used to extract individual columns. Returns
Parquet
/// general error when parsing or validation fails.
pub fn parse_message_type(message_type: &str) -> Result<Type> {
diff --git a/parquet/src/schema/printer.rs b/parquet/src/schema/printer.rs
index 12624513ac..0c90c5405a 100644
--- a/parquet/src/schema/printer.rs
+++ b/parquet/src/schema/printer.rs
@@ -51,8 +51,7 @@ use crate::file::metadata::{
};
use crate::schema::types::Type;
-/// Prints Parquet metadata
[`ParquetMetaData`](crate::file::metadata::ParquetMetaData)
-/// information.
+/// Prints Parquet metadata [`ParquetMetaData`] information.
#[allow(unused_must_use)]
pub fn print_parquet_metadata(out: &mut dyn io::Write, metadata:
&ParquetMetaData) {
print_file_metadata(out, metadata.file_metadata());
@@ -68,8 +67,7 @@ pub fn print_parquet_metadata(out: &mut dyn io::Write,
metadata: &ParquetMetaDat
}
}
-/// Prints file metadata [`FileMetaData`](crate::file::metadata::FileMetaData)
-/// information.
+/// Prints file metadata [`FileMetaData`] information.
#[allow(unused_must_use)]
pub fn print_file_metadata(out: &mut dyn io::Write, file_metadata:
&FileMetaData) {
writeln!(out, "version: {}", file_metadata.version());
@@ -92,7 +90,7 @@ pub fn print_file_metadata(out: &mut dyn io::Write,
file_metadata: &FileMetaData
print_schema(out, schema);
}
-/// Prints Parquet [`Type`](crate::schema::types::Type) information.
+/// Prints Parquet [`Type`] information.
#[allow(unused_must_use)]
pub fn print_schema(out: &mut dyn io::Write, tp: &Type) {
// TODO: better if we can pass fmt::Write to Printer.
diff --git a/parquet/src/schema/types.rs b/parquet/src/schema/types.rs
index bed85268ff..f0e1a7f27a 100644
--- a/parquet/src/schema/types.rs
+++ b/parquet/src/schema/types.rs
@@ -219,12 +219,12 @@ impl<'a> PrimitiveTypeBuilder<'a> {
}
}
- /// Sets [`Repetition`](crate::basic::Repetition) for this field and
returns itself.
+ /// Sets [`Repetition`] for this field and returns itself.
pub fn with_repetition(self, repetition: Repetition) -> Self {
Self { repetition, ..self }
}
- /// Sets [`ConvertedType`](crate::basic::ConvertedType) for this field and
returns itself.
+ /// Sets [`ConvertedType`] for this field and returns itself.
pub fn with_converted_type(self, converted_type: ConvertedType) -> Self {
Self {
converted_type,
@@ -232,7 +232,7 @@ impl<'a> PrimitiveTypeBuilder<'a> {
}
}
- /// Sets [`LogicalType`](crate::basic::LogicalType) for this field and
returns itself.
+ /// Sets [`LogicalType`] for this field and returns itself.
/// If only the logical type is populated for a primitive type, the
converted type
/// will be automatically populated, and can thus be omitted.
pub fn with_logical_type(self, logical_type: Option<LogicalType>) -> Self {
@@ -552,13 +552,13 @@ impl<'a> GroupTypeBuilder<'a> {
}
}
- /// Sets [`Repetition`](crate::basic::Repetition) for this field and
returns itself.
+ /// Sets [`Repetition`] for this field and returns itself.
pub fn with_repetition(mut self, repetition: Repetition) -> Self {
self.repetition = Some(repetition);
self
}
- /// Sets [`ConvertedType`](crate::basic::ConvertedType) for this field and
returns itself.
+ /// Sets [`ConvertedType`] for this field and returns itself.
pub fn with_converted_type(self, converted_type: ConvertedType) -> Self {
Self {
converted_type,
@@ -566,7 +566,7 @@ impl<'a> GroupTypeBuilder<'a> {
}
}
- /// Sets [`LogicalType`](crate::basic::LogicalType) for this field and
returns itself.
+ /// Sets [`LogicalType`] for this field and returns itself.
pub fn with_logical_type(self, logical_type: Option<LogicalType>) -> Self {
Self {
logical_type,
@@ -629,18 +629,18 @@ impl BasicTypeInfo {
self.repetition.is_some()
}
- /// Returns [`Repetition`](crate::basic::Repetition) value for the type.
+ /// Returns [`Repetition`] value for the type.
pub fn repetition(&self) -> Repetition {
assert!(self.repetition.is_some());
self.repetition.unwrap()
}
- /// Returns [`ConvertedType`](crate::basic::ConvertedType) value for the
type.
+ /// Returns [`ConvertedType`] value for the type.
pub fn converted_type(&self) -> ConvertedType {
self.converted_type
}
- /// Returns [`LogicalType`](crate::basic::LogicalType) value for the type.
+ /// Returns [`LogicalType`] value for the type.
pub fn logical_type(&self) -> Option<LogicalType> {
// Unlike ConvertedType, LogicalType cannot implement Copy, thus we
clone it
self.logical_type.clone()
@@ -787,12 +787,12 @@ impl ColumnDescriptor {
&self.path
}
- /// Returns self type [`Type`](crate::schema::types::Type) for this leaf
column.
+ /// Returns self type [`Type`] for this leaf column.
pub fn self_type(&self) -> &Type {
self.primitive_type.as_ref()
}
- /// Returns self type [`TypePtr`](crate::schema::types::TypePtr) for this
leaf
+ /// Returns self type [`TypePtr`] for this leaf
/// column.
pub fn self_type_ptr(&self) -> TypePtr {
self.primitive_type.clone()
@@ -803,12 +803,12 @@ impl ColumnDescriptor {
self.primitive_type.name()
}
- /// Returns [`ConvertedType`](crate::basic::ConvertedType) for this column.
+ /// Returns [`ConvertedType`] for this column.
pub fn converted_type(&self) -> ConvertedType {
self.primitive_type.get_basic_info().converted_type()
}
- /// Returns [`LogicalType`](crate::basic::LogicalType) for this column.
+ /// Returns [`LogicalType`] for this column.
pub fn logical_type(&self) -> Option<LogicalType> {
self.primitive_type.get_basic_info().logical_type()
}
@@ -928,14 +928,13 @@ impl SchemaDescriptor {
self.leaves.len()
}
- /// Returns column root [`Type`](crate::schema::types::Type) for a leaf
position.
+ /// Returns column root [`Type`] for a leaf position.
pub fn get_column_root(&self, i: usize) -> &Type {
let result = self.column_root_of(i);
result.as_ref()
}
- /// Returns column root [`Type`](crate::schema::types::Type) pointer for a
leaf
- /// position.
+ /// Returns column root [`Type`] pointer for a leaf position.
pub fn get_column_root_ptr(&self, i: usize) -> TypePtr {
let result = self.column_root_of(i);
result.clone()
@@ -960,7 +959,7 @@ impl SchemaDescriptor {
&self.schema.get_fields()[self.get_column_root_idx(i)]
}
- /// Returns schema as [`Type`](crate::schema::types::Type).
+ /// Returns schema as [`Type`].
pub fn root_schema(&self) -> &Type {
self.schema.as_ref()
}
