-
Notifications
You must be signed in to change notification settings - Fork 65
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
docs.rs links from inotify to inotify_sys are broken #212
Comments
Thanks for opening this issue, @eric-seppanen! I don't think I can get to this any time soon, but I'd be happy to merge a pull request that fixes this. |
I think that this can be fixed by using the "by name" link style. This emits an identical-looking page, and the links work locally. As I can tell from reading github issues it will also work on docs.rs. Would this style be acceptable? /// File was accessed
///
/// When watching a directory, this event is only triggered for objects
/// inside the directory, not the directory itself.
///
/// See [`inotify_sys::IN_ACCESS`].
const ACCESS = ffi::IN_ACCESS; |
I notice there are a lot of places where the docs unnecessarily specify html paths to other items. I think this hasn't been necessary since Rust 1.48, so it would be straightforward to do a cleanup pass removing things like
... as long as the symbol is in scope. |
Thanks for looking into this, @eric-seppanen!
Absolutely.
This crate is old 😂 First commit in April 2014, so almost 10 years! I just saw, after writing this, that you also submitted a pull request. Looking into it now! |
The docs for each of the
WatchMask
andEventMask
variants try to link to the docs.rs page forinotify_sys
, but the links are all broken.For example:
https://docs.rs/inotify/latest/inotify_sys/constant.IN_ACCESS.html is 404.
It should be:
https://docs.rs/inotify-sys/latest/inotify_sys/constant.IN_ACCESS.html
The text was updated successfully, but these errors were encountered: