From 001ab1a91d1182d7023329bd2342dbf6ec265554 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Sun, 2 Feb 2014 00:06:11 -0500 Subject: Hacking.md: change formatting on sample output a bit --- HACKING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'HACKING.md') diff --git a/HACKING.md b/HACKING.md index 2e5937b..ebe595b 100644 --- a/HACKING.md +++ b/HACKING.md @@ -51,13 +51,13 @@ lines that should not wrap, `echo` to print blank lines, `prose` to print paragraphs, `bullet` to print bullet points, and `flag` to print option flags. The text should follow this general format: - print |Usage: ${program} [OPTIONS] VARS_ARE_UNDERSCORE_AND_CAPITAL - print |One line description of program, no period + print "Usage: %s [OPTIONS] VARS_ARE_UNDERSCORE_AND_CAPITAL" "${program_name}" + print "One line description of program, no period" echo - prose |More details. This is a paragraph. + prose "More details. This is a paragraph." echo - print |Options: - flag | -h Show this message + print "Options:" + flag "-h" "Show this message" In the "Usage:" line, use printf `%s` and the value `"${0##*/}"` to determine the program name at runtime. -- cgit v1.2.2