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.

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

Add descriptions to each of the examples #171

Closed
vitiral opened this issue Mar 21, 2018 · 0 comments · Fixed by #1559
Closed

Add descriptions to each of the examples #171

vitiral opened this issue Mar 21, 2018 · 0 comments · Fixed by #1559
Labels
A-examples Area: The examples documentation

Comments

@vitiral
Copy link
Contributor

vitiral commented Mar 21, 2018

Right now there is no README or docstrings in main.rs for the examples, which makes them a lot less useful.

I would recommend adding a README to each one with a brief description of what it does and how to run it. A screenshot wouldn't hurt either.

I would be willing to do this with a 👍

@vitiral vitiral mentioned this issue Mar 21, 2018
8 tasks
@jstarry jstarry added documentation A-examples Area: The examples labels Dec 10, 2019
@jstarry jstarry added this to To do in Pain Point: Examples via automation Jul 6, 2020
@siku2 siku2 mentioned this issue Sep 15, 2020
3 tasks
Pain Point: Examples automation moved this from To do to Done Sep 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-examples Area: The examples documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants