path: root/
diff options
authorLuke Shumaker <>2014-11-25 23:08:35 -0500
committerLuke Shumaker <>2014-11-25 23:08:35 -0500
commitb22452767d33a017352b2423656bf4ddb0ff4b9b (patch)
tree4490cab3862d9c625fef76c0ede2d2613ee146d0 /
parentf8c57d68aa4f888f15fcb16485a5a29b3f413b1f (diff)
more meta-documentation cleanup
Diffstat (limited to '')
1 files changed, 14 insertions, 2 deletions
diff --git a/ b/
index 6682538..f22752e 100644
--- a/
+++ b/
@@ -102,7 +102,7 @@ use-case for it).
In the shebang, don't pass flags to bash, besides breaking `env`
(above), it means people will make mistakes when debugging, and
-running things with `bash FILENAME`. Instead, use `set` to adjust the
+running things with `bash FILENAME`. Instead, use `set` to adjust the
flags inside of the program.
Obey `$TMPDIR`. It's usually as easy as passing `--tmpdir` to
@@ -212,7 +212,7 @@ the better option, as otherwise you would have to use `seq` (calling
an external), or `eval` (gross, easy to mess up royally).
Indent comments like you would code; don't leave them at the beginning
-of the line. Example:
+of the line. Example:
for item in "${list[@]}"; do
if [[ $item == foo ]]; then
@@ -234,3 +234,15 @@ doesn't have to go on the right side of a command:
cat file | program # useless use of cat
program < file # data flows right to left
< file program # just right
+Copyright statements should look like
+ # Copyright (C) YEARS NAME <EMAIL>
+for most code, for 3rd-party code that has been imported, indent it a
+ # Copyright (C) YEARS NAME <EMAIL>
+Always put a line with `# License:` specifying the license of that