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

add fallback docs for crates #152

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Conversation

poopsicles
Copy link
Contributor

basically #151 (comment)

currently, if a crate has a docs value but no link, the custom docs are favoured over docs.rs/name

my editor auto-formatted, lemme know if you want me to turn that off

@djc
Copy link
Collaborator

djc commented Jan 10, 2025

Autoformatting is nice, but please put it in a separate commit? (Or PR if your prefer.)

@poopsicles
Copy link
Contributor Author

there's some clippy stuff so ill make a followup PR for all that

Copy link
Owner

@nicoburns nicoburns left a comment

Choose a reason for hiding this comment

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

I agree that auto-formatting should be a separate PR.

templates/macros/crate_table.html Outdated Show resolved Hide resolved
@poopsicles
Copy link
Contributor Author

poopsicles commented Jan 10, 2025

some crates have multiple sets of docs, the ones in bold are the ones i linked:

@poopsicles poopsicles marked this pull request as ready for review January 10, 2025 14:36
@poopsicles poopsicles requested a review from nicoburns January 10, 2025 14:51
Copy link
Collaborator

@djc djc left a comment

Choose a reason for hiding this comment

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

Thanks for digging this up, seems like a nice improvement!

Copy link
Owner

@nicoburns nicoburns left a comment

Choose a reason for hiding this comment

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

Some of these crates that have links because they weren't published to crates.io yet now are published (xilem, parley, vizia). But this seems like a solid improvement anyway. We might want to look at a way to link to both guide and reference docs at some point. Although I'm wary of providing too many options.

@nicoburns nicoburns merged commit 69217ad into nicoburns:main Jan 10, 2025
2 checks passed
@poopsicles poopsicles deleted the extra-docs branch January 15, 2025 15:08
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.

3 participants