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

Docs for replace_with_or_abort_unchecked() is missing #11

Open
korken89 opened this issue Nov 29, 2019 · 2 comments
Open

Docs for replace_with_or_abort_unchecked() is missing #11

korken89 opened this issue Nov 29, 2019 · 2 comments

Comments

@korken89
Copy link

Hi,

When clicking the link in the README, one comes to this site (no docs exists):
https://docs.rs/replace_with/0.1.5/replace_with/fn.replace_with_or_abort_unchecked.html

It seems that documentation is not generated for this function, but I have not looked deeper than that.

@tage64
Copy link
Contributor

tage64 commented Nov 29, 2019

The reason is that the function replace_with_or_abort_unchecked is behind a feature flag.

#[cfg(feature = "panic_abort")]
pub unsafe fn replace_with_or_abort_unchecked<T, F: FnOnce(T) -> T>(dest: &mut T, f: F) { ...

Rustdoc will not generate documentation for that function. We should maybe remove that link in the README.

@korken89
Copy link
Author

Ahh I see, and the docs feature flag has not been stabilized yet so it can't be used during documentation generation.
Probably removing the link is fine for now :)

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