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

Ensure links in the docs are correct #1741

Closed
alamb opened this issue Feb 3, 2022 · 5 comments
Closed

Ensure links in the docs are correct #1741

alamb opened this issue Feb 3, 2022 · 5 comments
Labels
enhancement New feature or request

Comments

@alamb
Copy link
Contributor

alamb commented Feb 3, 2022

Is your feature request related to a problem or challenge? Please describe what you are trying to do.
There are several broken links in the datafusion crate docs. For example

Screen Shot 2022-02-03 at 3 09 30 PM

Describe the solution you'd like
I would like them all links to be valid and ideally have a CI check to ensure they remain that way

Additional context

See similar ticket in arrow-rs: apache/arrow-rs#1267

@HaoYang670
Copy link
Contributor

I con work on it if no one else has been doing!

@HaoYang670
Copy link
Contributor

https://github.com/apache/arrow-datafusion/blob/master/datafusion/src/physical_plan/sorts/sort_preserving_merge.rs#L260

I got

the struct `SortPreservingMergeStream` has no field or associated item named `receivers`

when run cargo doc.
I am not sure what this link should be.

@HaoYang670
Copy link
Contributor

Also some structs are private, which leads to unsolved links, such as the SimplifyContext

@alamb
Copy link
Contributor Author

alamb commented Feb 11, 2022

@HaoYang670 yes some doc links are a mess -- thank you for taking this on. I will find time today to help sort out how to clean up the links

@Jefffrey
Copy link
Contributor

Duplicate of #6042

@Jefffrey Jefffrey marked this as a duplicate of #6042 Apr 21, 2024
@Jefffrey Jefffrey closed this as not planned Won't fix, can't repro, duplicate, stale Apr 21, 2024
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

No branches or pull requests

3 participants