Added comments to workflow and activity classes #247
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'm not going to merge this but I will come up with something that is compatible with https://phpdoc.org/ and make sure to include details from your comments. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When I'm trying to follow the logic path in the package, I find it helpful to have comments that help me remember the purpose of each class and method as I go. I have a few comments in the primary activity and workflow classes that have been helpful for me.
If the project would benefit from these, feel free to merge them in. If you prefer to keep the documentation out of the code and solely in the documentation site, I understand. I won't mind if you prefer to not merge this, but I wanted to offer in case anyone else would find these helpful.
Thanks!