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

Update README for 0.2.x examples #27

Open
simnh opened this issue Nov 8, 2018 · 1 comment
Open

Update README for 0.2.x examples #27

simnh opened this issue Nov 8, 2018 · 1 comment
Assignees
Labels

Comments

@simnh
Copy link
Member

simnh commented Nov 8, 2018

In the README not all examples are described. Do we want to have an updated list there or just remove these information from the README (I vote for latter, as it easier to maintain and people can easily go through the examples own their own and see whats there)

Right now its outdated, what is not that great... ;-)

@simnh simnh added the question label Nov 8, 2018
@uvchik
Copy link
Member

uvchik commented Nov 12, 2018

By now you have to add an example and one line to the README. I agree that an outdated README is bad. But the idea was to give new users an overview what are the topics of the examples. Sometimes it is hard to find the right example. A list of all modulestring would be great (sphinx?).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants