Author: particle
Date: 2009-02-01 01:26:46 +0100 (Sun, 01 Feb 2009)
New Revision: 25138
Modified:
docs/Perl6/Spec/S06-routines.pod
docs/Perl6/Spec/S19-commandline.pod
Log:
[spec] spelling, grammar, and other clarifications; TimToady++
Modified: docs/Perl6/Spec/S06-routines.pod
===================================================================
--- docs/Perl6/Spec/S06-routines.pod 2009-01-31 21:53:33 UTC (rev 25137)
+++ docs/Perl6/Spec/S06-routines.pod 2009-02-01 00:26:46 UTC (rev 25138)
@@ -2742,8 +2742,8 @@
-n :name
-n=value :name<value>
-nvalue :name<value> # only if not declared Bool
- -n="spacy value" :name«'spacy value'»
- -n='spacy value' :name«'spacy value'»
+ -n="spacey value" :name«'spacey value'»
+ -n='spacey value' :name«'spacey value'»
-n=val1,'val 2',etc :name«val1 'val 2' etc»
# Long names
@@ -2751,10 +2751,10 @@
--name=value :name<value> # don't care
--name value :name<value> # only if not declared Bool
- --name="spacy value" :name«'spacy value'»
- --name "spacy value" :name«'spacy value'»
- --name='spacy value' :name«'spacy value'»
- --name 'spacy value' :name«'spacy value'»
+ --name="spacey value" :name«'spacey value'»
+ --name "spacey value" :name«'spacey value'»
+ --name='spacey value' :name«'spacey value'»
+ --name 'spacey value' :name«'spacey value'»
--name=val1,'val 2',etc :name«val1 'val 2' etc»
--name val1 'val 2' etc :name«val1 'val 2' etc» # only if declared @
-- # end named argument processing
@@ -2762,16 +2762,16 @@
# Negation
--/name :!name
--/name=value :name<value> but False
- --/name="spacy value" :name«'spacy value'» but False
- --/name='spacy value' :name«'spacy value'» but False
+ --/name="spacey value" :name«'spacey value'» but False
+ --/name='spacey value' :name«'spacey value'» but False
--/name=val1,'val 2',etc :name«val1 'val 2' etc» but False
# Native
:name :name
:/name :!name
:name=value :name<value>
- :name="spacy value" :name«'spacy value'»
- :name='spacy value' :name«'spacy value'»
+ :name="spacey value" :name«'spacey value'»
+ :name='spacey value' :name«'spacey value'»
:name=val1,'val 2',etc :name«val1 'val 2' etc»
Exact Perl 6 forms are okay if quoted from shell processing:
Modified: docs/Perl6/Spec/S19-commandline.pod
===================================================================
--- docs/Perl6/Spec/S19-commandline.pod 2009-01-31 21:53:33 UTC (rev 25137)
+++ docs/Perl6/Spec/S19-commandline.pod 2009-02-01 00:26:46 UTC (rev 25138)
@@ -37,7 +37,7 @@
=item *
-Common options have a short, single-letter name, and allow clustering
+Common options have a short, single-character name, and allow clustering
=item *
@@ -101,11 +101,11 @@
=item *
-The most common options have a single-letter short name
+The most common options have a single-character short name
=item *
-Single-letter options may be clustered with the same syntax and semantics
+Single-character options may be clustered with the same syntax and semantics
=item *
@@ -239,14 +239,8 @@
=item *
-Options must begin with one of the following symbols: C<< < -- - : > >>.
+Options must begin with one of the following symbols: C<-->, C<->, or C<:>.
-=for consideration
-[That you are using < ... > P6 syntax as meta notation is not clear.
-Reads as if < and > are also allowed. Suggest
- 'C<-->', 'C<->', or 'C<:>'
-instead. --law]
-
=item *
Options are case sensitive. C<-o> and C<-O> are not the same option.
@@ -263,24 +257,20 @@
=item *
-Single-letter options may be clustered. C<-ab> means C<-a -b>. When a
-single-letter option which requires a value is clustered, the option may
+Single-character options may be clustered. C<-ab> means C<-a -b>. When a
+single-character option which requires a value is clustered, the option may
appear only in the final position of the cluster.
=item *
Options may be negated with C</>, for example C<--/name>, C<:/name>, C<-/n>.
-Each single-letter option in a cluster must be negated separately
-(e.g. C<-a/n/o> is the same as C<-a -/n -/o>.)
+Negated single-character options cannot appear in a cluster. In practice,
+negated options are rare anyway, as most boolean options default to False.
-=for consideration
-[I'd just outlaw clustering of negatives as too confusing visually.
-Most options are (or should be) born false anyway, so the need is minimal.
--law]
-
=item *
Option names follow Perl 6 identifier naming convention, except C<'> is not
-allowed, and single-letter options may be any letter or number.
+allowed, and single-character options may be any character or number.
=item *
@@ -291,16 +281,10 @@
=back
-Delimited options are a special form of option that are specified by
-delimiters on either end, allowing options to be passed through to specified
-subsystems, and are parsed with the following rules:
-
-=for consideration
Delimited options allow you to transparently pass one or more options through
to
a subsystem, as specified by the special options that delimit those options.
They are parsed according to the following rules:
-
=over 4
=item *
@@ -369,28 +353,20 @@
=item *
-Values containing whitespace must be enclosed in quotes, for example
-C<-O="spacy val">
-
-=for consideration
-[everyone's gonna wonder if spacy is a typo... --law]
-
-=item *
-
Values are passed to options with the following syntax C<--option=value>
or C<--option value>.
-=for consideration
-[swap the last two entries. --law]
+=item *
+Values containing whitespace must be enclosed in quotes, for example
+C<-O="spacey value">
+
=item *
Multiple values are passed using commas without intervening whitespace,
-as in C<--option=val1,'val 2',etc>
+as in C<--option=val1,'val 2',etc>, or by specifying multiple instances
+of the option, as in C<--option=val1 --option='val 2'>.
-=for consideration
-[what about multiple instances of --option? --law]
-
=back
