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

refactor(agent): Format agent code #4784

Merged
merged 15 commits into from
Apr 5, 2023
Merged

Conversation

agrski
Copy link
Contributor

@agrski agrski commented Apr 4, 2023

What this PR does / why we need it:
This PR improves the formatting of various parts of the Core v2 agent's codebase. Improvements includ:

  • Adding blank for logical grouping (and easier navigation in some editors/modes).
  • Splitting long lines, e.g. for method signatures, over multiple lines. This aids legibility, as humans are generally not good at reading across wide texts. Part of this is about too many things on one line, which makes separating them difficult, and another part of it is about how much eye movement is required to scan code.
  • Using more consistent splitting of lines. Maintaining consistency sets expectations for how to read the code and minimises the risk of important information being (literally) overlooked.

This PR should be a pure refactor; no functional changes are expected to have been introduced.

Which issue(s) this PR fixes:
N/A

Special notes for your reviewer:
N/A

@agrski agrski requested a review from ukclivecox April 4, 2023 16:33
@agrski agrski marked this pull request as ready for review April 4, 2023 16:34
Add blank lines for logical grouping.
Use consistent line breaks.
Move a few declarations closer to usage.
@ukclivecox ukclivecox added the v2 label Apr 5, 2023
@agrski agrski merged commit e290be7 into SeldonIO:v2 Apr 5, 2023
@agrski agrski deleted the format-agent-code branch April 5, 2023 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants