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] Add examples and doc-tests for them #265

Open
sea212 opened this issue Aug 13, 2021 · 0 comments
Open

[Documentation] Add examples and doc-tests for them #265

sea212 opened this issue Aug 13, 2021 · 0 comments
Labels
p:low Low priority, resolution of this issue can wait t:enhancement The issue described an enhancement

Comments

@sea212
Copy link
Member

sea212 commented Aug 13, 2021 •
edited
Loading

Implement examples and doc-tests for them at least for every public function which could be used by different projects.
https://doc.rust-lang.org/rustdoc/documentation-tests.html
https://dev.to/minkovsky/what-s-up-doc-rust-doctests-and-you-254e
@sea212 sea212 added p:low Low priority, resolution of this issue can wait t:enhancement The issue described an enhancement labels Aug 13, 2021
@sea212 sea212 changed the title [Documentation] Add an example and doc-tests for it [Documentation] Add examples and doc-tests for them Aug 13, 2021
@sea212 sea212 mentioned this issue Aug 13, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
p:low Low priority, resolution of this issue can wait t:enhancement The issue described an enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sea212