Mathias Panzenböck avatar Mathias Panzenböck committed 9bf5a50

parseopt: fixed many typos in README

Comments (0)

Files changed (1)

parseopt/README.md

 	                Only one of both may be used at the same time.
 
 	                Names can be long options (e.g. '--foo') and short options
-	                (e.g. '-f'). The first name is used to indentify the option.
+	                (e.g. '-f'). The first name is used to identify the option.
 	                Names musst be unique and may not contain '='.
 
-	                Short options may be combined when passed to a programm. E.g.
+	                Short options may be combined when passed to a program. E.g.
 	                the options '-f' and '-b' can be combined to '-fb'. Only one
 	                of these combined options may require an argument.
 
-	                Short options are separated from ther arguments by space,
-	                long options per '='. If a long option requires an argument
-	                and none is passed using '=' it also uses the next commandline
-	                argument as it's argument (like short options).
+	                Short options are separated from their arguments by space,
+	                long options by '='. If a long option requires an argument
+	                and none is passed using '=' it also uses the next command
+	                line argument as it's argument (like short options).
 
 	                If '--' is encountered all remaining arguments are treated as
 	                arguments and not as options.
 	   details:     array, optional
 	                short list of details shown in braces after the option name
 	                e.g. integer type options add 'base: '+base if base !== undefined
-	   metavar:     string or array, per deflault inferred from type
+	   metavar:     string or array, per default inferred from type
 	   onOption:    function (value) -> boolean, optional
-	                Returning true canceles any further option parsing
+	                Returning true cancels any further option parsing
 	                and the parse() method returns null.
 
 	   // Type: string  (alias: str)
 
 	   // Type: enum
 	   ignoreCase:  boolean, default: true
-	   values:      array or object where the user enteres the field name of
-	                the object and you get the value of the field
+	   values:      array of possible values or object where the user enters the
+	                property name of the object and you get the value of the property
 
 	   // Type: record
 	   create:      function () -> object, default: Array
 Parse an `integer` option argument. You can optionally specify `min` and `max`
 parameters to the option definition in order to limit the range of allowed
 values. Using the boolean `NaN` parameter it can be controlled if `NaN`
-values are allowed (default: `false`). The `base` parameter controlls the
+values are allowed (default: `false`). The `base` parameter controls the
 base of the parsed number. Per default integers are parsed like JavaScript
-integer lieterals, meaning a `0x` prefix specifies a hexadecimal number, a
+integer literals, meaning a `0x` prefix specifies a hexadecimal number, a
 `0` prefix an octal number and otherwise it is interpreted as a decimal number.
 
 Example:
 
 A `record` option accepts several option arguments. How many and which types
 is specified through the `args` parameter. This parameter accepts an array of
-option definitions (some parameters of these option definietions are ignored:
+option definitions (some parameters of these option definitions are ignored:
 `name`, `default`, `required`, `redefinable`, `help`, `details`, `onOption`).
 The type ot the record itself can be provided through the `create` parameter
 (function, default: Array).
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.