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

Wrong links in docs #1

Open
eugenesvk opened this issue Dec 6, 2024 · 4 comments
Open

Wrong links in docs #1

eugenesvk opened this issue Dec 6, 2024 · 4 comments

Comments

@eugenesvk
Copy link
Contributor

link to value on this page https://docs.rs/osakit/latest/osakit/type.Value.html
opens an invalid
https://docs.rs/serde_json/1.0.133/x86_64-apple-darwin/serde_json/value/enum.Value.html

which redirects to an invalid search query

which should instead be
https://docs.rs/serde_json/1.0.133/serde_json/enum.Value.html

since serde_json doesn't seem to have platform-dependend values?

@mdevils
Copy link
Owner

mdevils commented Dec 8, 2024

Hello @eugenesvk. I believe these docs are generated by docs.rs itself. Do you have any idea why it fails in this case?

@eugenesvk
Copy link
Contributor Author

I think it fails because there is no x86_64-apple-darwin platform in the serde crate while your crate has it.

Though no idea whether it's possible to configure docs to link to non-platform-specific docs in a dependency

@mdevils
Copy link
Owner

mdevils commented Dec 8, 2024

This is how these links defined in osakit:

/// [`serde_json::Value`] from [`serde_json`].
pub type Value = serde_json::Value;
/// [`serde_json::Number`] from [`serde_json`].
pub type Number = serde_json::Number;
/// [`serde_json::Map`] from [`serde_json`].
pub type Map<K, V> = serde_json::Map<K, V>;
/// [`serde_json::from_value`] from [`serde_json`].
pub use serde_json::from_value;
/// [`serde_json::to_value`] from [`serde_json`].
pub use serde_json::to_value;

When generating docs locally, everything works fine.

Looks like this is a bug of https://docs.rs.

@eugenesvk
Copy link
Contributor Author

eugenesvk commented Dec 8, 2024

yeah, locally as far as I understand, it doesn't generate any platforms except the one you compile it on, you don't have the platform picker, so it's not an issue

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

2 participants