[GitHub] [arrow-datafusion] alamb opened a new issue, #6042: Fix rustdoc errors

["alamb (via GitHub)" <gi...@apache.org>]

alamb opened a new issue, #6042:
URL: https://github.com/apache/arrow-datafusion/issues/6042

   ### Is your feature request related to a problem or challenge?
   
   If you run `cargo doc` today on the datafusion crate, there are several errors, which result in broken links, for example:
   
   ```
   
   warning: unresolved link to `1,4`
      --> datafusion/core/src/physical_plan/joins/utils.rs:745:22
       |
   745 | /// The result is: ([1,4], [null, null])
       |                      ^^^ no item named `1,4` in scope
       |
       = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
   
   warning: unresolved link to `DistributedReceiver`
     --> datafusion/core/src/physical_plan/repartition/distributor_channels.rs:88:37
      |
   88 | /// This occurs when the [receiver](DistributedReceiver) is gone.
      |                                     ^^^^^^^^^^^^^^^^^^^ no item named `DistributedReceiver` in scope
      |
      = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
   
   warning: unresolved link to `ExecutionPlan`
     --> datafusion/core/src/scheduler/pipeline/mod.rs:36:26
      |
   36 | /// within DataFusion, [`ExecutionPlan`], but rather a generic interface that
      |                          ^^^^^^^^^^^^^ no item named `ExecutionPlan` in scope
      |
      = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
   
   ```
   
   ### Describe the solution you'd like
   
   Now that we publish the rustdocs regularly as part of releases to crates.io I would like the docs to not have broken links. 
   
   Thus I would like `cargo doc` to run cleanly and I would like a CI lint check that ensures new errors do not get introduced
   
   ### Describe alternatives you've considered
   
   _No response_
   
   ### Additional context
   
   _No response_


-- 
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: github-unsubscribe@arrow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] alamb closed issue #6042: Fix rustdoc errors

["alamb (via GitHub)" <gi...@apache.org>]

alamb closed issue #6042: Fix rustdoc errors
URL: https://github.com/apache/arrow-datafusion/issues/6042


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org