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.

Sign up for GitHub

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

Jump to bottom

scripts: renamed function _errex -> _exit_with_error #2497

Merged
merged 2 commits into from Mar 21, 2022
Merged

scripts: renamed function _errex -> _exit_with_error #2497

merged 2 commits into from Mar 21, 2022

Conversation

georglauterbach
Copy link
Member

Description

To maintainers, it is clear what _errex is, because we're working with
it frequently. The nameing choice, however, was (IMHO) no good. It is
needlessly short (why abbreviate error) and does not communicate its
functionality very well.

Now, it's very clear and yet not too long.## Type of change

  • Improvement (non-breaking change that does improve existing functionality)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@georglauterbach
renamed function _errex -> _exit_with_error
493e11e 
To maintainers, it is clear what `_errex` is, because we're working with
it frequently. The nameing choice, however, was (IMHO) no good. It is
needlessly short (why abbreviate error) and does not communicate its
functionality very well.

Now, it's very clear and yet not too long.
@georglauterbach georglauterbach added area/scripts kind/update Update an existing feature, configuration file or the documentation labels Mar 21, 2022
@georglauterbach georglauterbach added this to the v11.0.0 milestone Mar 21, 2022
@georglauterbach georglauterbach self-assigned this Mar 21, 2022
@georglauterbach georglauterbach merged commit b7bf40a into master Mar 21, 2022
@georglauterbach georglauterbach deleted the rename-errex branch March 21, 2022 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@casperklein casperklein casperklein approved these changes

@polarathene polarathene polarathene approved these changes

Assignees

@georglauterbach georglauterbach

Labels
area/scripts kind/update Update an existing feature, configuration file or the documentation
Projects
None yet
Milestone
v11.0.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@georglauterbach @casperklein @polarathene