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

Trim excess whitespace #4575

Merged
merged 1 commit into from
Sep 27, 2021
Merged

Trim excess whitespace #4575

merged 1 commit into from
Sep 27, 2021

Conversation

a1346054
Copy link
Contributor

Split from #4497 for further discussion.

For trailing whitespace a commit hook/CI check could be implemented, but most of the excess whitespace is within other text which makes it harder for automated tools to deal with. I mainly spotted it when reading through the files.

Copy link
Collaborator

@kmk3 kmk3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

 src/man/firejail-profile.txt                  | 32 ++++++++---------
 src/man/firejail.txt                          | 36 +++++++++----------

Please leave existing double-spacing (". ") as is.

It makes text much more readable in monospace fonts IMO. It also makes editing
less error-prone, as it allows e.g.: vim to detect when a sentence ends vs when
you're just using an abbreviation (e.g.: "Mr.") and act accordingly on
commands that operate on sentences.

For a more extensive write-up, I found the following blog post:

It's kind of a rant, but it explains the main points.

Other than that, LGTM.

@a1346054
Copy link
Contributor Author

The arguments are sound, I'll rework the PR to not remove those two spaces after a sentence.

The original reason why I removed them was to make it consistent with all the other text in firejail, where two spaces are not used.

@a1346054 a1346054 changed the title Trim excess whitespace WIP: Trim excess whitespace Sep 25, 2021
@a1346054
Copy link
Contributor Author

Rebased the PR to implement your review comments.

@a1346054 a1346054 changed the title WIP: Trim excess whitespace Trim excess whitespace Sep 25, 2021
Copy link
Collaborator

@kmk3 kmk3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@a1346054 commented on Sep 24:

The arguments are sound, I'll rework the PR to not remove those two spaces
after a sentence.

The original reason why I removed them was to make it consistent

That makes sense.

with all the other text in firejail, where two spaces are not used.

To be fair, there are a few more places where it's used (see with e.g.:
git grep -I -n '\. ').

@a1346054 commented on Sep 25:

Rebased the PR to implement your review comments.

Thanks for that and for the whitespace fixes.

@kmk3 kmk3 merged commit 09485e3 into netblue30:master Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To Document (RELNOTES/man)
Development

Successfully merging this pull request may close these issues.

3 participants