Skip to content

Better Documentation for Types #60

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

Closed
KodrAus opened this issue Mar 7, 2016 · 5 comments
Closed

Better Documentation for Types #60

KodrAus opened this issue Mar 7, 2016 · 5 comments
Assignees
Milestone

Comments

@KodrAus
Copy link
Member

KodrAus commented Mar 7, 2016

Add more useful docs to module roots in the types crate. This should include examples of how to define types with default mappings, create custom mapping etc.

Base the docs around what users are likely going to want to do, and provide alternatives and details on the method docs themselves.

@KodrAus KodrAus added the types label Mar 7, 2016
@KodrAus KodrAus added this to the 0.2 - CI milestone Mar 7, 2016
@KodrAus KodrAus self-assigned this Mar 7, 2016
@KodrAus
Copy link
Member Author

KodrAus commented Mar 7, 2016

Once #59 is implemented, there should be enough to cover some standard scenarios in the docs.

@KodrAus KodrAus modified the milestones: 0.3 - Rotor / Types, 0.2 - CI, 0.2 - Types, 0.3 - Rotor Mar 10, 2016
@KodrAus
Copy link
Member Author

KodrAus commented Mar 15, 2016

Waiting on #65

@KodrAus
Copy link
Member Author

KodrAus commented Mar 25, 2016

This is improving in general along with the module design

@KodrAus
Copy link
Member Author

KodrAus commented Apr 1, 2016

Pick this issue up again once the core types are implemented so the docs can be worked on as a whole.

@KodrAus
Copy link
Member Author

KodrAus commented Apr 17, 2016

The state of the types documentation is much better now.

Examples of building types with compiler plugins will be added as they're done as per normal.

@KodrAus KodrAus closed this as completed Apr 17, 2016
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

1 participant