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

Add docstrings and generate documentation #6

Closed
simonmesmith opened this issue Aug 3, 2023 · 2 comments · Fixed by #31
Closed

Add docstrings and generate documentation #6

simonmesmith opened this issue Aug 3, 2023 · 2 comments · Fixed by #31
Assignees
@simonmesmith
Labels
p1
Milestone
Share on LinkedIn

Comments

@simonmesmith
Copy link
Owner

No description provided.

@simonmesmith simonmesmith added p2 p1 and removed p2 labels Aug 4, 2023
@simonmesmith simonmesmith changed the title Add docstrings to modules, classes, and functions Add docstrings and generate documentation Aug 5, 2023
@simonmesmith
Copy link
Owner Author

  1. Add docstrings to modules, classes, and functions
  2. Use Sphinx and GitHub Actions to automatically generate documentation

@simonmesmith simonmesmith added this to the Share on LinkedIn milestone Aug 5, 2023
@simonmesmith simonmesmith self-assigned this Aug 5, 2023
simonmesmith added a commit that referenced this issue Aug 5, 2023
@simonmesmith
Refactor as part of #6
c898f27
simonmesmith added a commit that referenced this issue Aug 5, 2023
@simonmesmith
Add docstrings to run and test modules for #6
97c0503
simonmesmith added a commit that referenced this issue Aug 5, 2023
@simonmesmith
Made small update for #6
a1d5d60
@simonmesmith
Copy link
Owner Author

Not going to generate documentation for now, as I don't think it's needed. Developers can just look at the docstrings.

simonmesmith added a commit that referenced this issue Aug 6, 2023
@simonmesmith
Add Sphinx-style documentation to close #6
22e040d
@simonmesmith simonmesmith linked a pull request Aug 6, 2023 that will close this issue
Add docstrings and generate documentation #31
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@simonmesmith simonmesmith

Labels
p1
Projects
None yet
Milestone
Share on LinkedIn
Development

Successfully merging a pull request may close this issue.

Add docstrings and generate documentation simonmesmith/agentflow
1 participant
@simonmesmith