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.

Sign up for GitHub

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

Jump to bottom

Documentation #66

Open
garro95 opened this issue Jun 14, 2020 · 1 comment
Open

Documentation #66

garro95 opened this issue Jun 14, 2020 · 1 comment

Comments

@garro95
Copy link

garro95 commented Jun 14, 2020 •
edited
Loading

Please, improve the crate documentation.
I suggest adding specific documentation to the derive macros sections, possibly with examples.

In particular the documentation does not say anything about CopyGetters and MutGetters. The signature of the generated methods is not clear for example.

Also the options are not sufficiently described IMO
@Hoverbear
Copy link
Collaborator

You're right! These things could definitely be improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Hoverbear @garro95