Skip to content

Commit 0a188fb

Browse files
author
Zachary Norman
committed
Typo and README updates
1 parent 2835211 commit 0a188fb

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# InputValidator
22

3-
Routine that can be used to perform input validation for any routine to ensure that parameters are present or a certain type. You can specify each possible type that the data value can represent and optionally require that the value have all of the types. Here are the generic types that can be used:
3+
Routine that can be used to perform input validation for any routine to ensure that parameters are present or a certain type. You can specify each possible types that the data value can represent and optionally require that the value have all of the types. Here are the generic types that can be used for any variable:
44

55
- required : If set, the value must be present and defined.
66

77
- array : If set, value supplied must be an array.
88

99
- number : If set, value supplied must be a number.
1010

11-
This routine uses IDL's `isa` function to make the comparison so, in addition to the types above, you can specify anything else that can pass as an argument. Some exampled are: byte, int, long, float, hash, orderedhash, enviraster. They can be any IDL-specific data type and it can also be the type of object such as idlgrwindow or any named, custom object type.
11+
This routine uses IDL's `isa` function to make the comparison so, in addition to the types above, you can specify anything else that can pass as an argument to the `isa` routine. Some additional examples of types are are: byte, int, long, float, hash, orderedhash, enviraster, graphicswin. The addition arguments can be any IDL-specific data type or it can also be the type of object such as idlgrwindow or any named, custom object.
1212

1313
## Examples
1414

@@ -20,7 +20,7 @@ See the PRO code on descriptions of the keywords.
2020
inputValidator, hash('nameOfArg', 'required')
2121
```
2222

23-
Note that this means the variable is not undefined (i.e. defined in the IDL code or passed in as a parameter). A variable defined as `!NULL` will still pass.
23+
Note that this means the variable is not undefined (i.e. defined in the IDL code or passed in as a parameter). A variable defined as `!NULL` will still pass because that is a valid value of a variable.
2424

2525
### Validate that an argument is a string array and present
2626

0 commit comments

Comments
 (0)