[make:webhook] Rephrase comments to be more explicit + minor improvement of generated code #1512
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.
Previously, the generated code of
FooRequestParser::doParse
started with// Implement your own logic to validate and parse the request, and return a RemoteEvent object.
, followed by an empty line, then some code. I think it may be confusing for the developers, some may think the custom logic should live right bellow the comment and that the following code should not be messed with.I think that changing this to
// TODO: Adapt or replace the content of this method to fit your need.
might help clear things up.Additionally I removed an unnecessary check for null in the generated code + fixed the payload conversion method in the fixture.