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

How to link to lazy API members in Rust API docs? #211

Open
mcandre opened this issue Apr 16, 2023 · 0 comments
Open

How to link to lazy API members in Rust API docs? #211

mcandre opened this issue Apr 16, 2023 · 0 comments

Comments

@mcandre
Copy link

mcandre commented Apr 16, 2023

I tried the [<entity name here>] syntax cited in the official Rust manual:

https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html

However, this does not appear to be rendering in my package.

/// clean runs [CLEAN_TASKS]. in:

https://github.com/mcandre/cclean/blob/ad448b69fa6f8827da08537d4ceef80c7fc0421d/src/lib.rs#L97

Unfortunately renders as clean runs [CLEAN_TASKS]. (no hyperlink generated) in:

https://docs.rs/cclean/latest/cclean/

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

No branches or pull requests

1 participant