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.

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

Fix rustdoc errors #6042

Closed
Tracked by #3058
alamb opened this issue Apr 18, 2023 · 0 comments · Fixed by #6044
Closed
Tracked by #3058

Fix rustdoc errors #6042

alamb opened this issue Apr 18, 2023 · 0 comments · Fixed by #6044
Labels
enhancement New feature or request

Comments

@alamb
Copy link
Contributor

alamb commented Apr 18, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant