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

Improve overview / introduction in README / docs.rs #76

Closed
epage opened this issue Mar 23, 2019 · 0 comments
Closed

Improve overview / introduction in README / docs.rs #76

epage opened this issue Mar 23, 2019 · 0 comments
Labels
enhancement Improve the expected

Comments

@epage
Copy link
Contributor

epage commented Mar 23, 2019

From @passcod in #74

For other docs-related things, see my comment on the assert_fs issue as this crate is structured very similarly and suffers from most of the same issues.

I'm assuming referring to

Foremost, while the rustdoc is good as a reference, the upfront documentation is severely lacking. The readme is practically useless both for figuring out what this is (beyond the title, which is only helpful if one knows what all the words mean), and figuring out what it can do (and hence, whether it can be used for one's usecase). Going to the docs.rs page in some hope of more is equally discouraging (and also non-obvious from github as it's only linked through the badge), as the crate top-level documentation is an extremely succinct "overview" that doesn't really explain anything.

See assert-rs/assert_fs#46

@epage epage added the enhancement Improve the expected label Mar 23, 2019
@epage epage closed this as completed in db71885 Mar 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improve the expected
Projects
None yet
Development

No branches or pull requests

1 participant