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

Relaxing the stated limitation about UTF-8 in documentation #8551

Closed
oliviercailloux opened this issue Jul 24, 2020 · 2 comments
Closed

Relaxing the stated limitation about UTF-8 in documentation #8551

oliviercailloux opened this issue Jul 24, 2020 · 2 comments

Comments

@oliviercailloux
Copy link
Contributor

oliviercailloux commented Jul 24, 2020

Is your feature request related to a problem? Please describe.
The web site states: “Java code should be written with ASCII characters only, no UTF-8 support.” This is ambiguous. I suppose that it means at least that identifiers must be in pure ASCII, but does it also mean that all file content must be in pure ASCII? Can I use UTF-8 in //comments? Can I use UTF-8 in Strings?

In supplement of being ambiguous, it is a strong restriction, if it is meant in the wide sense of all file content being restricted to pure ASCII. For example, Google Java Style writes: “Tip: Never make your code less readable simply out of fear that some programs might not handle non-ASCII characters properly. If that should happen, those programs are broken and they must be fixed.”

Describe the solution you'd like
Please consider allowing UTF-8 in comments and Strings, and update the sentence referenced above accordingly.

If this is not considered possible / adequate, please change the sentence anyway to make the limitation unambiguous.

Additional context
From this discussion and this question, I suspect that Checkstyle already supports UTF-8 in comments and strings. So I suspect this feature request would be easily implemented. And it would bring important value to those who (like me) agree with the quote from Google Java Style here above.

Other (vaguely) related issue: #2784.

@romani
Copy link
Member

romani commented Jul 26, 2020

Please consider allowing UTF-8 in comments and Strings, and update the sentence referenced above accordingly.

It should be supported already. Please use our CLI to show a case where it is not supported.

If all works well, please suggest better wording. All web site content is in source code of repo

@romani romani added the approved label Nov 3, 2020
@romani romani changed the title Consider relaxing the stated limitation about UTF-8 Relaxing the stated limitation about UTF-8 Nov 5, 2020
@romani romani changed the title Relaxing the stated limitation about UTF-8 Relaxing the stated limitation about UTF-8 in documentation Nov 5, 2020
@romani
Copy link
Member

romani commented Nov 7, 2020

Fix in documentation is merged

@romani romani closed this as completed Nov 7, 2020
@romani romani added this to the 8.38 milestone Nov 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants