Skip to content

Commit 03bb4e1

Browse files
committed
Documentation edits.
1 parent 0db60e1 commit 03bb4e1

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

preprocess-cl.lua

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ exec lua "$0" "$@"
3333
contain other backticks.
3434
3535
--data|-d="Any data."
36-
A string with any data. If the option is present then the value
36+
A string with any data. If this option is present then the value
3737
will be available through the global 'dataFromCommandLine' in the
38-
processed files (and the message handler, if you have one).
38+
processed files (and any message handler). Otherwise,
39+
'dataFromCommandLine' is nil.
3940
4041
--handler|-h=pathToMessageHandler
4142
Path to a Lua file that's expected to return a function or a
@@ -50,17 +51,19 @@ exec lua "$0" "$@"
5051
Add comments with line numbers to the output.
5152
5253
--meta
53-
Output the metaprogram to a temporary file (*.meta.lua). Useful
54-
if an error happens in the metaprogram. This file is removed if
55-
there's no error and --debug isn't enabled.
54+
Output the metaprogram to a temporary file (*.meta.lua). Useful if
55+
an error happens when the metaprogram runs. This file is removed
56+
if there's no error and --debug isn't enabled.
5657
5758
--nonil
58-
Disallow !() and outputValue() to output nil.
59+
Disallow !(...) and outputValue(...) from outputting nil.
5960
6061
--outputextension=fileExtension
6162
Specify what file extension generated files should have. The
6263
default is "lua". If any input files end in .lua then you must
63-
specify another file extension.
64+
specify another file extension with this option. (It's suggested
65+
that you use .lua2p (as in "Lua To Process") as extension for
66+
unprocessed files.)
6467
6568
--outputpaths|-o
6669
This flag makes every other specified path be the output path
@@ -531,7 +534,7 @@ printfNoise(
531534

532535
--[[!===========================================================
533536
534-
Copyright © 2018-2019 Marcus 'ReFreezed' Thunström
537+
Copyright © 2018-2021 Marcus 'ReFreezed' Thunström
535538
536539
Permission is hereby granted, free of charge, to any person obtaining a copy
537540
of this software and associated documentation files (the "Software"), to deal

preprocess.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2177,7 +2177,7 @@ return lib
21772177

21782178
--[[!===========================================================
21792179
2180-
Copyright © 2018-2020 Marcus 'ReFreezed' Thunström
2180+
Copyright © 2018-2021 Marcus 'ReFreezed' Thunström
21812181
21822182
Permission is hereby granted, free of charge, to any person obtaining a copy
21832183
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)