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

Improve List documentation #803

Open
luleyleo opened this issue Apr 5, 2020 · 2 comments · May be fixed by #2302
Open

Improve List documentation #803

luleyleo opened this issue Apr 5, 2020 · 2 comments · May be fixed by #2302
Labels
D-Easy just needs to be implemented docs concerns documentation help wanted has no one working on it yet

Comments

@luleyleo
Copy link
Collaborator

luleyleo commented Apr 5, 2020

The List widget does not really have any documentation right now except for the example project.

It would be nice if the docs would at least explain

  • Why it is needed
  • How to use it (including what ListIter is)
  • How to make it scroll
@luleyleo luleyleo added docs concerns documentation D-Easy just needs to be implemented help wanted has no one working on it yet labels Apr 5, 2020
@Valentine-Mario
Copy link

I was also concerned why the entire project lack proper documentation. This would be a total turn off for people looking for a GUI library to use.

@derekdreery
Copy link
Collaborator

@Valentine-Mario this is a bit OT for here - use this for development and zulip for questions.

That said, the reason the docs are lacking is because it is early days and things are still changing. Someone could invest time in writing documentation, that is then out of date a week later. This development stage is a necessary part of creating an optimal solution in the long term, but if you were to come back later you would find things a lot more stable and well documented.

PRs adding docs are always welcome though. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-Easy just needs to be implemented docs concerns documentation help wanted has no one working on it yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants