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

Write some docs #74

Closed
dwgnr opened this issue Jan 11, 2024 · 2 comments
Closed

Write some docs #74

dwgnr opened this issue Jan 11, 2024 · 2 comments

Comments

@dwgnr
Copy link
Collaborator

dwgnr commented Jan 11, 2024

No description provided.

@dwgnr dwgnr changed the title Documentation plz Write some docs Jan 11, 2024
@BoolPurist
Copy link
Collaborator

BoolPurist commented Jan 18, 2024 •
edited
Loading

One important thing is that most public functions do not have any API documentation.

The following are points should be in an API documentation for rust function.

  • Summary: What it can be used for.
  • Error section: In case the function returns a result value. This section describes which condition lead to an error variant.
  • None section: In case the function returns a option value. This section describes which condition lead to a None variant.

@BoolPurist BoolPurist mentioned this issue Apr 22, 2024
Merged
@BoolPurist
Copy link
Collaborator

Done by PR #81

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
@dwgnr @BoolPurist