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

Fix function calls with inconsistent argument breaking #932

Merged

Conversation

pleshakov
Copy link
Contributor

Proposed changes

Problem:

Solution:

  • Fix the problems in the code, except for ginkgo helpers in tests, because of their readability.
  • Add an example of a functional call to the guidelines

Testing: N/A

Closes N/A

Note: this was promised in the PR review -- #905 (comment)

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Problem:
- The code doesn't follow the guideline: when breaking up a
call, choose to break after each parameter argument. See
https://github.com/nginxinc/nginx-kubernetes-gateway/blob/0ff13226b16cfec44f509542b25bc3f2fcf610cc/docs/developer/go-style-guide.md#consistent-line-breaks
- THe guidelines don't have an example of a function call

Solution:
- Fix the problems in the code, except for ginkgo helpers in tests,
because of their readability.
- Add an example of a functional call to the guidelines
@pleshakov pleshakov requested a review from a team as a code owner August 2, 2023 21:08
@github-actions github-actions bot added documentation Improvements or additions to documentation tech-debt Short-term pain, long-term benefit labels Aug 2, 2023
@pleshakov pleshakov merged commit 0c3d74a into nginxinc:main Aug 3, 2023
21 checks passed
@pleshakov pleshakov deleted the tech-debt/fix-inconsistent-line-breaks branch August 3, 2023 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tech-debt Short-term pain, long-term benefit
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants