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

Cut all trailing whitespace including funky unicode characters #393

Closed
sadielbartholomew opened this issue Sep 13, 2022 · 2 comments · Fixed by #399
Closed

Cut all trailing whitespace including funky unicode characters #393

sadielbartholomew opened this issue Sep 13, 2022 · 2 comments · Fixed by #399
Assignees

Comments

@sadielbartholomew
Copy link
Member

sadielbartholomew commented Sep 13, 2022

The AsciiDoc files, newly cleaned up as part of #387, still have trailing whitespace, including whitespace in the form of some funky unicode characters, e.g. U+00A0, which should be removed for code hygiene.

Suggested as part of abiding by style guides in #373 (comment). While the specific style guides are being debated, all (sensible ones) will advocate for no trailing whitespace, so this is not controversial and can be done immediately, and should be done as one, like with the first stage clean-up #387, to aid reviewing and avoiding creating merge conflicts.

Assigning myself to try to do this now.

@sadielbartholomew
Copy link
Member Author

sadielbartholomew commented Sep 13, 2022

Forgot to add a quick screenshot of my text editor with a whitespace-detecting mode enabled, demonstrating some of this on ch09.adoc as an example, the yellow strange symbols indicate unicode whitespace, yellow centered dots standard whitespace:

whitespace_cf_conventions

@DocOtak
Copy link
Member

DocOtak commented Sep 13, 2022

Oh... U+00A0 are non breaking space characters in ISO/IEC 8859-1. aka LATIN-1. That is not UTF-8 all (there are invalid bytes and byte sequences in UTF8).

Seeing this, we really must have some statement on the character encoding of our source documents for asciidoc and the markdown sources. This is not a statement about how to encode characters in the CF conforming data files.

@squaregoldfish squaregoldfish self-assigned this Sep 14, 2022
squaregoldfish added a commit to squaregoldfish/cf-conventions that referenced this issue Sep 14, 2022
squaregoldfish added a commit to squaregoldfish/cf-conventions that referenced this issue Sep 14, 2022
Removed all found whitespaces, including unicode non-breaking spaces
@squaregoldfish squaregoldfish linked a pull request Sep 15, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants