Skip to content

Commit

Permalink
Merge pull request #13 from jackfirth/docs-core-#2
Browse files Browse the repository at this point in the history
Add documentation of core form
  • Loading branch information
jackfirth committed Apr 1, 2015
2 parents 314448d + f91d4f7 commit a191ce4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
23 changes: 23 additions & 0 deletions command-line-ext/scribblings/core-form.scrbl
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#lang scribble/manual

@(require package-scribblings-tools
(for-label command-line-ext
racket/cmdline
racket/base))

@title{Core Forms}

@defform[(command-line-ext maybe-name flag-clause ... final-clause)]{
Like @racket[command-line], but with a few important differences.
In addition to the normal options for @racket[flag-clause] that
@racket[command-line] allows, a flag clause may also be of the
form @racket[(begin-flags flag-clause ...)], which has exactly
the same semantics as if each @racket[flag-clause] contained
within @racket[begin-flags] was spliced into the surrounding
list of flag clauses. Additionally, @racket[command-line-ext]
supports @italic{command line flag expanders}, which are similar
to @racket[match] expanders and allow a user to extend the
grammar of @racket[flag-clause]. A custom @racket[flag-clause]
created with @racket[define-command-line-flag-expander] can
expand to multiple flag clauses by using @racket[begin-flags].
}
3 changes: 1 addition & 2 deletions command-line-ext/scribblings/main.scrbl
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#lang scribble/manual

@(require scribble/eval
package-scribblings-tools
@(require package-scribblings-tools
(for-label command-line-ext
racket/cmdline
racket/base))
Expand Down

0 comments on commit a191ce4

Please sign in to comment.