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

Fixed broken documentation links for Directed and Undirected enums. #426

Merged
merged 2 commits into from
May 12, 2021
Merged

Fixed broken documentation links for Directed and Undirected enums. #426

merged 2 commits into from
May 12, 2021

Conversation

john-hartley
Copy link
Contributor

I'm not sure if there's an automated way to test for broken documentation links, as I'm new to Rust, so I've verified locally using cargo doc --open.

Thanks for the crate all the same. I was tearing my hair out trying to figure out how to work with graphs.

@ABorgna
Copy link
Member

ABorgna commented May 11, 2021

Thanks for checking!
There is cargo-deadlinks, which shows there are still other broken links. Do you want to fix them?

We could think about adding that check to the CI at some point.

@john-hartley
Copy link
Contributor Author

No problem!

I'm happy to fix the other errors, but I've run into a problem installing cargo-deadlinks, for which I've created an issue in one of its dependencies. Once I get that sorted, then I'll fix the rest.

@john-hartley
Copy link
Contributor Author

I've fixed the remaining problems reported by cargo deadlinks.

Where I've added #[doc(hidden)] to some methods it's because the traits that declare those methods have also marked them as #[doc(hidden)]. deadlinks was reporting that they don't exist because #[doc(hidden)] was applied to the trait but not the implementation.

@ABorgna
Copy link
Member

ABorgna commented May 12, 2021

Great ☺
Thanks for the contribution.

@ABorgna ABorgna merged commit 69de2ea into petgraph:master May 12, 2021
@john-hartley john-hartley deleted the broken-doc-links branch May 12, 2021 09:45
@ABorgna ABorgna added this to the 0.6 milestone May 16, 2021
teuron pushed a commit to teuron/petgraph that referenced this pull request Oct 9, 2022
…etgraph#426)

* Fixed broken documentation links for Directed and Undirected enums.

* Fixed the remaining errors reported by cargo deadlinks.
teuron pushed a commit to teuron/petgraph that referenced this pull request Oct 9, 2022
…etgraph#426)

* Fixed broken documentation links for Directed and Undirected enums.

* Fixed the remaining errors reported by cargo deadlinks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants