My thinking:
- If there was a pretty long code line above anyhow that gets harder to read if new line split using
\
, then it would be wasteful to pretend we’re enforcing an 80 characters line limit for comments.
- Sometimes finishing off a sentence in new line making it look less pretty.
- Sometimes easier to read to finish a sentence of thought then making a new line.
- Certainly don’t add new line if shell output or anything else was copied/pasted into the source code. Such as “example output for command x is:”. Better to keep at least that original because that helps to better understand the string parsing that follows below.
Related:
I am not sure. Surely we don’t need to limit ourselves to 80 characters as if we were stuck in the age of virtual terminals with maximum 80 characters line length?
Can we refer to other, existing, popular style guides?
Makes sense. Current style is $example
for simplicity and ${example}
whenever required or contributed so. Changing to ${example}
could be done if there was a script or command which would change that given a file.
Automation scripts / functions already in whonix-developer-meta-files:
- loop over every Whonix package
- loop over every source file
- do something on every source file
- run git diff before running git commit
The only thing missing is changing $varname
to ${varname}
. Ideally test / review that this doesn’t add any breakage.