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

1011: Updated docblock for code generator #1022

Conversation

doninAtwix
Copy link
Contributor

@doninAtwix doninAtwix commented Mar 1, 2022

Description (*)
Updated docblock for code generator.
Screenshot 2022-03-07 at 15 07 41
Screenshot 2022-03-07 at 15 06 51
Screenshot 2022-03-07 at 15 05 41
Screenshot 2022-03-07 at 15 04 22
Screenshot 2022-03-07 at 15 03 43
Screenshot 2022-03-07 at 14 58 31
Screenshot 2022-03-07 at 14 57 50
Screenshot 2022-03-07 at 14 54 02
Screenshot 2022-03-07 at 14 53 22
Screenshot 2022-03-07 at 14 51 36
Screenshot 2022-03-07 at 14 49 40
Screenshot 2022-03-07 at 14 39 13
Screenshot 2022-03-07 at 14 36 14
Screenshot 2022-03-07 at 14 34 17
Screenshot 2022-03-07 at 14 33 12
Screenshot 2022-03-07 at 14 32 13
Screenshot 2022-03-07 at 14 29 26
Screenshot 2022-03-07 at 14 27 01
Screenshot 2022-03-07 at 14 25 38
Screenshot 2022-03-07 at 14 24 16

Fixed Issues (if relevant)

  1. Fixes Code Generator uses prohibited code snippets #1011

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with integration/functional tests (if applicable)
  • All automated tests passed successfully (all builds are green)

Copy link
Collaborator

@bohdan-harniuk bohdan-harniuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, @doninAtwix!

Why did you add new lines here?

Screenshot 2022-03-07 at 11 25 48

That is the result of a such addition:

Screenshot 2022-03-07 at 11 25 09

Please, fix that.

Also, it is important to add screenshots for all changed files into the PR's body (not as new comment).

Regards,

@bohdan-harniuk
Copy link
Collaborator

Hello, @doninAtwix!

Could you please finish each description in the annotation with the . sign?
Also, before each @return statement in the annotation add an empty annotation line.

It is a good example how it should be:

Screenshot 2022-03-11 at 10 12 09

Regards,

@bohdan-harniuk bohdan-harniuk self-requested a review March 17, 2022 08:59
Copy link
Collaborator

@bohdan-harniuk bohdan-harniuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@doninAtwix, thank you, for your work here!

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

Successfully merging this pull request may close these issues.

Code Generator uses prohibited code snippets
2 participants