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

Not adequate README/links to documentation on crates.io for file-id #571

Open
0xCCF4 opened this issue Feb 25, 2024 · 0 comments
Open

Not adequate README/links to documentation on crates.io for file-id #571

0xCCF4 opened this issue Feb 25, 2024 · 0 comments

Comments

@0xCCF4
Copy link

0xCCF4 commented Feb 25, 2024

Hey, I just searched for a crate that reads out file ids for linux and windows and found the file-id crate.

When viewing the crate on https://crates.io/crates/file-id the page shows misleading information. It seems like somehow the README and Cargo.toml of the main (notify) repo was published for the file-id crate (including a wrong link to the notify documentation https://docs.rs/notify).

It's a minor inconvenience to guess the correct documentation link https://docs.rs/file-id/latest/file_id/ and that the README (that exists here: https://github.com/notify-rs/notify/blob/main/file-id/README.md) is not displayed on the crates.io https://crates.io/crates/file-id page.

Interestingly when viewing the source on doc.rs https://docs.rs/crate/file-id/latest/source/Cargo.toml, it seems like the correct files were uploaded but https://docs.rs/crate/file-id/latest/source/Cargo.toml.orig seems to be invalid.

Looking forward to a fix

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