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

Improve error message for locale check #6821

Merged
merged 5 commits into from Dec 6, 2018

Conversation

Projects
None yet
3 participants
@Eric-Arellano
Copy link
Contributor

Eric-Arellano commented Nov 27, 2018

In #6305, we began to require UTF-8 for Pants to work properly.

After helping a Pants user via Slack to figure out the error message and how to respond to it, we identified some small tweaks to the error message that can make it even more clear and human-readable:

  • Use second-person to make message friendlier.
  • Explain that we resolve encoding via locale.getpreferredencoding(). This helps to clarify that while LC_ALL and LANG are likely what need to be changed, those are means to the end, not the end itself.
  • Clarify that the bypass is valid to use, only means we cannot guarantee valid behavior.
Improve error message for locale check
In #6305, we began to require UTF-8 for Pants to work properly.

After helping a Pants user via Slack to figure out the error message and how to respond to it, we identified some small tweaks to the error message that can make it even more clear and human-readable:

* Use second-person to make message friendlier.
* Explain that we resolve encoding via `locale.getpreferredencoding()`. This helps to clarify that while LC_ALL and LANG are likely what need to be changed, those are means to the end, not the end itself.
* Clarify that the bypass is valid to use, only means we cannot guarantee valid behavior.

@Eric-Arellano Eric-Arellano requested review from stuhood and cosmicexplorer Nov 27, 2018

@Eric-Arellano Eric-Arellano requested a review from baroquebobcat Nov 29, 2018

@stuhood

stuhood approved these changes Dec 4, 2018

@Eric-Arellano Eric-Arellano merged commit a566e2d into pantsbuild:master Dec 6, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@Eric-Arellano Eric-Arellano deleted the Eric-Arellano:improve-system-encoding-message branch Dec 6, 2018

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