[ 
https://issues.apache.org/jira/browse/ARROW-11168?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Andrew Lamb resolved ARROW-11168.
---------------------------------
    Fix Version/s: 3.0.0
       Resolution: Fixed

Issue resolved by pull request 9133
[https://github.com/apache/arrow/pull/9133]

> [Rust] Fix cargo doc warnings
> -----------------------------
>
>                 Key: ARROW-11168
>                 URL: https://issues.apache.org/jira/browse/ARROW-11168
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: Rust
>            Reporter: Qingyou Meng
>            Assignee: Qingyou Meng
>            Priority: Major
>              Labels: pull-request-available
>             Fix For: 3.0.0
>
>          Time Spent: 3h
>  Remaining Estimate: 0h
>
> {code:java}
>    Compiling parquet_derive v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/parquet_derive)
> warning: unresolved link to `array::data::ArrayData`
>   --> arrow/src/lib.rs:73:64
>    |
> 73 | //! Data in [`Array`](array::Array) is stored in 
> [`ArrayData`](array::data::ArrayData), that in turn
>    |                                                                
> ^^^^^^^^^^^^^^^^^^^^^^ no item named `data` in module `array`
>    |
>    = note: `#[warn(broken_intra_doc_links)]` on by defaultwarning: unresolved 
> link to `array::data::ArrayData`
>   --> arrow/src/lib.rs:74:44
>    |
> 74 | //! is a collection of other [`ArrayData`](array::data::ArrayData) and 
> [`Buffers`](buffer::Buffer).
>    |                                            ^^^^^^^^^^^^^^^^^^^^^^ no 
> item named `data` in module `array`warning: unresolved link to `0`
>   --> arrow/src/array/array_primitive.rs:52:67
>    |
> 52 |     /// raw_values must have a value equivalent to 
> data.buffers()[0].raw_data()
>    |                                                                   ^ no 
> item named `0` in scope
>    |
>    = help: to escape `[` and `]` characters, add '\' before them like `\[` or 
> `\]`warning: unresolved link to `Datatype`
>   --> arrow/src/ffi.rs:24:115
>    |
> 24 | //! The second interface maps native Rust types to the Rust-specific 
> implementation of Arrow such as `format` to [Datatype],
>    |                                                                          
>                                          ^^^^^^^^ no item named `Datatype` in 
> scope
>    |
>    = help: to escape `[` and `]` characters, add '\' before them like `\[` or 
> `\]`warning: unresolved link to `4`
>    --> arrow/src/ipc/gen/Message.rs:339:63
>     |
> 339 | /// For example, a List<Int16> with values [[1, 2, 3], null, [4], [5, 
> 6], null]
>     |                                                               ^ no item 
> named `4` in scope
>     |
>     = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `0`
>     --> arrow/src/ipc/gen/Schema.rs:1597:15
>      |
> 1597 | ///   - child[0] entries: Struct
>      |               ^ no item named `0` in scope
>      |
>      = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `0`
>     --> arrow/src/ipc/gen/Schema.rs:1598:17
>      |
> 1598 | ///     - child[0] key: K
>      |                 ^ no item named `0` in scope
>      |
>      = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `1`
>     --> arrow/src/ipc/gen/Schema.rs:1599:17
>      |
> 1599 | ///     - child[1] value: V
>      |                 ^ no item named `1` in scope
>      |
>      = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `offset`
>     --> arrow/src/ipc/gen/Schema.rs:1706:28
>      |
> 1706 | /// for each child typeIds[offset] is the id used in the type vector
>      |                            ^^^^^^ no item named `offset` in scope
>      |
>      = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `i`
>    --> arrow/src/ipc/gen/SparseTensor.rs:521:40
>     |
> 521 |     /// The i-th row spans from indptr[i] to indptr[i+1] in the data.
>     |                                        ^ no item named `i` in scope
>     |
>     = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `smith2017knl`
>    --> arrow/src/ipc/gen/SparseTensor.rs:753:14
>     |
> 753 |     /// See [smith2017knl]: http://shaden.io/pub-files/smith2017knl.pdf
>     |              ^^^^^^^^^^^^ no item named `smith2017knl` in scope
>     |
>     = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `i`
>    --> arrow/src/ipc/gen/SparseTensor.rs:795:75
>     |
> 795 |     /// indptrBuffers. A pair of consecutive values at 
> indptrBuffers[dim][i]
>     |                                                                         
>   ^ no item named `i` in scope
>     |
>     = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: unresolved link to `i`
>    --> arrow/src/ipc/gen/SparseTensor.rs:797:73
>     |
> 797 |     /// indicesBuffers[dim + 1] who are children of 
> indicesBuffers[dim][i] node.
>     |                                                                         
> ^ no item named `i` in scope
>     |
>     = help: to escape `[` and `]` characters, add '\' before them like `\[` 
> or `\]`warning: 13 warnings emitted Documenting futures v0.3.8
>  Documenting tower-balance v0.3.0
>  Documenting tower v0.3.1
>  Documenting parquet v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/parquet)
>  Documenting arrow-integration-testing v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/integration-testing)
>  Documenting hyper v0.13.9
> warning: unresolved link to `1`
>   --> parquet/src/arrow/levels.rs:23:79
>    |
> 23 | //! Parquet achieves nesting through definition levels and repetition 
> levels [1].
>    |                                                                          
>      ^ no item named `1` in scope
>    |
>    = note: `#[warn(broken_intra_doc_links)]` on by default
>    = help: to escape `[` and `]` characters, add '\' before them like `\[` or 
> `\]`warning: unresolved link to `1`
>   --> parquet/src/arrow/levels.rs:40:6
>    |
> 40 | //! [1] https://github.com/apache/parquet-format#nested-encoding
>    |      ^ no item named `1` in scope
>    |
>    = help: to escape `[` and `]` characters, add '\' before them like `\[` or 
> `\]`warning: unresolved link to `self::file::metadata::Statistics`
>   --> parquet/src/column/page.rs:96:41
>    |
> 96 |     /// Returns optional 
> [`Statistics`](crate::file::metadata::Statistics).
>    |                                         
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `Statistics` in module 
> `metadata`warning: unresolved link to `self::record::api::Row`
>   --> parquet/src/record/reader.rs:19:13
>    |
> 19 | //! [`Row`](crate::record::api::Row)s.
>    |             ^^^^^^^^^^^^^^^^^^^^^^^ no item named `api` in module 
> `record`warning: unresolved link to `self::record::api::Row`
>    --> parquet/src/record/reader.rs:631:25
>     |
> 631 | /// Iterator of [`Row`](crate::record::api::Row)s.
>     |                         ^^^^^^^^^^^^^^^^^^^^^^^ no item named `api` in 
> module `record`warning: unresolved link to `1`
>   --> parquet/src/arrow/levels.rs:23:79
>    |
> 23 | //! Parquet achieves nesting through definition levels and repetition 
> levels [1].
>    |                                                                          
>      ^ no item named `1` in scope
>    |
>    = note: `#[warn(broken_intra_doc_links)]` on by default
>    = help: to escape `[` and `]` characters, add '\' before them like `\[` or 
> `\]`warning: unresolved link to `self::record::api::Row`
>    --> parquet/src/record/reader.rs:787:34
>     |
> 787 | /// Internal iterator of [`Row`](crate::record::api::Row)s for a reader.
>     |                                  ^^^^^^^^^^^^^^^^^^^^^^^ no item named 
> `api` in module `record`warning: unresolved link to `1`
>   --> parquet/src/arrow/levels.rs:40:6
>    |
> 40 | //! [1] https://github.com/apache/parquet-format#nested-encoding
>    |      ^ no item named `1` in scope
>    |
>    = help: to escape `[` and `]` characters, add '\' before them like `\[` or 
> `\]`warning: unresolved link to `self::record::api::Row`
>    --> parquet/src/record/reader.rs:666:37
>     |
> 666 |     /// Creates iterator of [`Row`](crate::record::api::Row)s for all 
> row groups in a
>     |                                     ^^^^^^^^^^^^^^^^^^^^^^^ no item 
> named `api` in module `record`warning: unresolved link to 
> `self::record::api::Row`
>    --> parquet/src/record/reader.rs:678:37
>     |
> 678 |     /// Creates iterator of [`Row`](crate::record::api::Row)s for a 
> specific row group.
>     |                                     ^^^^^^^^^^^^^^^^^^^^^^^ no item 
> named `api` in module `record`warning: unresolved link to 
> `self::record::api::Row`
>    --> parquet/src/record/reader.rs:692:39
>     |
> 692 |     /// Creates a iterator of [`Row`](crate::record::api::Row)s from a
>     |                                       ^^^^^^^^^^^^^^^^^^^^^^^ no item 
> named `api` in module `record`warning: unresolved link to 
> `self::file::metadata::Statistics`
>   --> parquet/src/column/page.rs:96:41
>    |
> 96 |     /// Returns optional 
> [`Statistics`](crate::file::metadata::Statistics).
>    |                                         
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `Statistics` in module 
> `metadata`warning: unresolved link to `self::record::api::Row`
>    --> parquet/src/record/reader.rs:705:47
>     |
> 705 |     /// Tries to create a iterator of [`Row`](crate::record::api::Row)s 
> using projections.
>     |                                               ^^^^^^^^^^^^^^^^^^^^^^^ 
> no item named `api` in module `record`warning: unresolved link to 
> `self::record::api::Row`
>   --> parquet/src/record/reader.rs:19:13
>    |
> 19 | //! [`Row`](crate::record::api::Row)s.
>    |             ^^^^^^^^^^^^^^^^^^^^^^^ no item named `api` in module 
> `record`warning: unresolved link to `self::record::api::Row`
>    --> parquet/src/record/reader.rs:631:25
>     |
> 631 | /// Iterator of [`Row`](crate::record::api::Row)s.
>     |                         ^^^^^^^^^^^^^^^^^^^^^^^ no item named `api` in 
> module `record`warning: unresolved link to `self::record::api::Row`
>    --> parquet/src/record/reader.rs:787:34
>     |
> 787 | /// Internal iterator of [`Row`](crate::record::api::Row)s for a reader.
>     |                                  ^^^^^^^^^^^^^^^^^^^^^^^ no item named 
> `api` in module `record`warning: unresolved link to `self::record::api::Row`
>    --> parquet/src/record/reader.rs:666:37
>     |
> 666 |     /// Creates iterator of [`Row`](crate::record::api::Row)s for all 
> row groups in a
>     |                                     ^^^^^^^^^^^^^^^^^^^^^^^ no item 
> named `api` in module `record`warning: unresolved link to 
> `self::record::api::Row`
>    --> parquet/src/record/reader.rs:678:37
>     |
> 678 |     /// Creates iterator of [`Row`](crate::record::api::Row)s for a 
> specific row group.
>     |                                     ^^^^^^^^^^^^^^^^^^^^^^^ no item 
> named `api` in module `record`warning: unresolved link to 
> `self::record::api::Row`
>    --> parquet/src/record/reader.rs:692:39
>     |
> 692 |     /// Creates a iterator of [`Row`](crate::record::api::Row)s from a
>     |                                       ^^^^^^^^^^^^^^^^^^^^^^^ no item 
> named `api` in module `record`warning: unresolved link to 
> `self::record::api::Row`
>    --> parquet/src/record/reader.rs:705:47
>     |
> 705 |     /// Tries to create a iterator of [`Row`](crate::record::api::Row)s 
> using projections.
>     |                                               ^^^^^^^^^^^^^^^^^^^^^^^ 
> no item named `api` in module `record`warning: 10 warnings emittedwarning: 10 
> warnings emitted Documenting datafusion v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/datafusion)
>  Documenting parquet_derive v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/parquet_derive)
>  Documenting tonic v0.3.1
>  Documenting parquet_derive_test v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/parquet_derive_test)
> warning: unresolved link to `Arrow::error::ArrowError`
>   --> datafusion/src/error.rs:62:45
>    |
> 62 |     /// Wraps this [DataFusionError] as an [Arrow::error::ArrowError].
>    |                                             ^^^^^^^^^^^^^^^^^^^^^^^^ no 
> item named `Arrow` in scope
>    |
>    = note: `#[warn(broken_intra_doc_links)]` on by defaultwarning: 1 warning 
> emitted Documenting arrow-benchmarks v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/benchmarks)
>  Documenting arrow-flight v3.0.0-SNAPSHOT 
> (/Users/mqy/tools/data/arrow/rust/arrow-flight)
>     Finished dev [unoptimized + debuginfo] target(s) in 1m 21s
> {code}



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to