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

Link listed types in lib.rs to their docs #1144

Merged
merged 1 commit into from Sep 12, 2022

Conversation

Patiga
Copy link
Contributor

@Patiga Patiga commented Aug 19, 2022

Helpful because lib.rs is the 'main page' for docs.rs
This allows for easy/direct access to the mentioned types
Currently you need to look up mentioned types via the search bar

Copy link
Sponsor Collaborator

@Andlon Andlon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is indeed very helpful!

I only noticed a missing space, otherwise looks good to me. I didn't try to pull down and builds the docs though - can you verify that the docs indeed render correctly and that the links work?

src/lib.rs Outdated Show resolved Hide resolved
Helpful because lib.rs is the 'main page' for docs.rs
This allows for easy/direct access to the mentioned types
Currently you need to look up mentioned types via the search bar
@Patiga
Copy link
Contributor Author

Patiga commented Sep 3, 2022

I have tested all the links.
Links that don't work throw a warning with cargo doc, maybe that check could be added to the CI.

@Andlon Andlon merged commit 7adecde into dimforge:dev Sep 12, 2022
@Andlon
Copy link
Sponsor Collaborator

Andlon commented Sep 12, 2022

Thanks @Patiga!

I have tested all the links. Links that don't work throw a warning with cargo doc, maybe that check could be added to the CI.

That's a good idea, I created #1151 for this purpose.

@Patiga Patiga deleted the lib-doc-link-items branch September 15, 2022 10:48
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