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

Add documentation to the actual code #1308

Open
Blackclaws opened this issue Oct 14, 2024 · 0 comments
Open

Add documentation to the actual code #1308

Blackclaws opened this issue Oct 14, 2024 · 0 comments

Comments

@Blackclaws
Copy link

Is your feature request related to a problem? Please describe.
First of all thank you for even creating the library. I couldn't help but notice unfortunately that the usage of this library is mainly documented in samples and some ReadTheDocs but not a lot of documentation about any of the methods exists in the actual code. This makes working with the library more difficult than it has to be because one essentially needs to dig into the source code to understand what some things actually do.

CancelCondition is one example. I expected its a condition that is checked once at its point in the workflow whether the workflow should cancel at this point, seems it is checked regularly throughout the workflow. But can also be used to cancel parallel workflows as per some release notes?

Describe the solution you'd like
Add documentation to at least all the public facing methods that describe properly what they do and also add an example usage in there.

Describe alternatives you've considered
Trawl through the source code to gather this information myself. I've done this now and its really not efficient.

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

No branches or pull requests

2 participants