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

Comprehensive examples for documentation #456

Open
cjdb opened this issue Sep 2, 2024 · 1 comment
Open

Comprehensive examples for documentation #456

cjdb opened this issue Sep 2, 2024 · 1 comment

Comments

@cjdb
Copy link

cjdb commented Sep 2, 2024

I find it very difficult to learn how APIs work without clear examples of intended usage, even for very simple things. Would it be too much trouble to add examples to each part of the API so that the intended use is clear, please? Examples for demonstrating and discussing general use (e.g. sus::ptr's demo would go somewhere on the main sus::ptr page) and for each part of the API (e.g. sus::ptr::as_ref examples would be put in the sus::ptr::as_ref page) would be appreciated.

This is potentially a subtask of #321.

@danakj
Copy link
Collaborator

danakj commented Sep 8, 2024

Agreeing more docs and examples are needed :) Only a few sections have gotten that higher level of attention so far, like option.

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