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

Documentation mismatch for scopeguard::guard_on_unwind #42

Open
wyf18 opened this issue Apr 14, 2023 · 1 comment
Open

Documentation mismatch for scopeguard::guard_on_unwind #42

wyf18 opened this issue Apr 14, 2023 · 1 comment

Comments

@wyf18
Copy link

wyf18 commented Apr 14, 2023

Hello! 🐙
While scanning crates.io. we noticed a document-code mismatch issue in this crate, we think the doc examples are generally meant to illustrate why someone would want to use the item.

Location

documentation for scopeguard::guard_on_unwind
(https://docs.rs/scopeguard/1.1.0/scopeguard/fn.guard_on_unwind.html)

Summary

The example of the document does not mention the guard_on_unwind function, it is not clear how to use it.

Thank you for checking out this issue! 👍🤗

If there's any reason you don't think this is a mismatch issue, please let me know, we're doing an empirical study of documentation in the Rust ecosystem. Your answers will help us and better promote the development of the Rust ecosystem.

@konsumlamm
Copy link
Contributor

The example shows how to emulate guard_on_unwind in a no-std environment, so it isn't a documentation mismatch.

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