replace_with icon indicating copy to clipboard operation
replace_with copied to clipboard

Docs for `replace_with_or_abort_unchecked()` is missing

Open korken89 opened this issue 4 years ago • 2 comments

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.

korken89 avatar Nov 29 '19 08:11 korken89

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.

tage64 avatar Nov 29 '19 08:11 tage64

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 :)

korken89 avatar Nov 29 '19 08:11 korken89