Add XML Code Comments For The HTTP Activities #3127
Merged
Conversation
This file contains 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
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 create workflows using the Elsa I use the Builder API.
There is a sparse amount of XML code comments on the methods and properties so the learning curve to using the Builder API is pretty steep.
So, this is a venture to add XML code comments to Elsa. Hopefully making it easier for new users to pick it up. This PR focuses on the HTTP activities.
A large majority of the builder extensions are exactly the same with some of the parameter types changed around so
inheritdocis used quite a bit. This also means that if the maintainers of elsa-core don't think that a comment is accurate a whole swath of them can be changed rather easily.