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 #171

Open
JHopeCollins opened this issue Feb 22, 2024 · 0 comments
Open

Documentation #171

JHopeCollins opened this issue Feb 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@JHopeCollins
Copy link
Member

What documentation should we have, and what would we like to have?

We currently have docstrings on everything(?), but these require either reading through the code, or knowing what the classes/methods are called to check them with pydoc.

Possible improvements include:

  1. API documentation on a webpage. We could see how gusto / irksome / defcon do things.
  2. Manual pages on a webpage.
    • Overview of asQ / library aims
    • Library structure / design philosophy
    • Explanations of the various modules and example uses
    • FAQ / troubleshooting
  3. Jupyter notebooks with serial examples
@JHopeCollins JHopeCollins added the documentation Improvements or additions to documentation label Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JHopeCollins