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 documentation #8

Open
1 of 2 tasks
carterbox opened this issue Feb 18, 2022 · 0 comments
Open
1 of 2 tasks

Write some documentation #8

carterbox opened this issue Feb 18, 2022 · 0 comments

Comments

@carterbox
Copy link
Contributor

carterbox commented Feb 18, 2022 •
edited by stevehenke
Loading

I've read all of the code. Most of it seems to be boilerplate (like describing widget layouts and such), so I can understand why widgets don't need docstrings, but there is absolutely no documentation.

There should be at least:

  • a short explanation on the README of how to start the program?
  • a developer explanation of how wrapping a reconstruction api for the gui works?
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
1 participant
@carterbox