Skip to content

Commit ab592a4

Browse files
committed
Add some TODOs, a comment, and delete trailing whitespace
1 parent 6b127db commit ab592a4

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

macros.dylan

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@ synopsis: Interface macros for parser definition and option access.
33
authors: David Lichteblau <lichteblau@fhtw-berlin.de>
44
copyright: See LICENSE file in this distribution.
55
6+
// TODO(cgay): Two improvements for synopsis
7+
// 1. We have almost all the information we need to automatically generate
8+
// the usage line: "test [options] file...". The `positional-arguments`
9+
// clause needs a `name:` option so the dylan name needn't be used.
10+
// 2. It's odd that `description` is a keyword argument to the synopsis clause
11+
// when the description is the one thing that can't be auto-generated and
12+
// should always be specified. Make it its own `description` clause and
13+
// change `synopsis` to `usage`, which should usually not be needed.
14+
//
15+
// TODO(cgay): Support for min/max number of positional args. The parser already
16+
// supports them. (This will improve `usage` auto-generation too.)
17+
618
// Introduction
719
// ============
820
//
@@ -137,6 +149,8 @@ copyright: See LICENSE file in this distribution.
137149
// --version Show version
138150
//
139151

152+
// Note: add the `traced` adjective to the `define macro` definitions to get
153+
// some help from the compiler when debugging these hairy macros.
140154

141155
// Macro COMMAND-LINE-DEFINER--exported
142156
// =======================================
@@ -262,7 +276,7 @@ define macro defcmdline-class
262276
{ (?usage:*) ... }
263277
=> { ... }
264278
{ } => { }
265-
279+
266280
default:
267281
{ ?:expression }
268282
=> { default: ?expression }

0 commit comments

Comments
 (0)