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

improve code documentation (cargo doc) #29

Closed
ScanMountGoat opened this issue Apr 1, 2021 · 0 comments
Closed

improve code documentation (cargo doc) #29

ScanMountGoat opened this issue Apr 1, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ScanMountGoat
Copy link
Member

Base types such as Mesh, Skel, etc should be annotated with their supported versions. Comments should link to related types, functions, etc. Public functions should contain short example code when possible, which also allows for additional tests.
@ScanMountGoat ScanMountGoat added the documentation Improvements or additions to documentation label Apr 1, 2021
@ScanMountGoat ScanMountGoat changed the title improve documentation for struct definitions improve code documentation (cargo doc) Apr 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ScanMountGoat