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

Missing documentation for package operators and public classes #173

Closed
glopesdev opened this issue Jul 27, 2024 · 4 comments · Fixed by #177
Closed

Missing documentation for package operators and public classes #173

glopesdev opened this issue Jul 27, 2024 · 4 comments · Fixed by #177
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@glopesdev
Copy link
Collaborator

glopesdev commented Jul 27, 2024

While reorganizing the project for packaging, I noticed the following operators and types remain undocumented:

We could potentially internalize some of these as implementation-specific classes (e.g. ContextTask, PassthroughState) in addition to the ones already internalized in #172. This would simplify both the API and docs effort at this point, but the operators will need to be included.

@glopesdev glopesdev added the documentation Improvements or additions to documentation label Jul 27, 2024
@glopesdev glopesdev added this to the 0.1.0 milestone Jul 27, 2024
@jonnew
Copy link
Member

jonnew commented Jul 27, 2024 via email

@glopesdev
Copy link
Collaborator Author

glopesdev commented Jul 28, 2024

@jonnew great, let me know if you want me to merge #172 to main beforehand so you have a few less classes to worry about.

@jonnew
Copy link
Member

jonnew commented Jul 28, 2024

That would be helpful. Im going to fork from 172 for my working copy

@glopesdev
Copy link
Collaborator Author

Great, no need to fork, I have merged it now.

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

Successfully merging a pull request may close this issue.

2 participants