Skip to content

Commit

Permalink
Rename project to Validoozy
Browse files Browse the repository at this point in the history
  • Loading branch information
apjanke committed Apr 28, 2019
1 parent 28e24a4 commit 41fa6b6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions Mcode/load_validatentine.m → Mcode/load_validoozy.m
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
function load_validatentine(varargin)
%LOAD_VALIDATENTINE Load the Validatentine library
function load_validoozy(varargin)
%LOAD_VALIDOOZY Load the Validoozy library
%
% load_validatentine
% load_validatentine -override
% load_validoozy
% load_validoozy -override
%
% This loads the Validatentine library and makes it ready for use.
% This loads the Validoozy library and makes it ready for use.
%
% When you run this function, the appropriate paths from Validatene are added
% When you run this function, the appropriate paths from Validoozy are added
% to your Matlab path.
%
% If the -override option is supplied, then the "compat" functions are added
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
Validatentine for Matlab
Validoozy for Matlab
========================

Additional validator functions for Matlab.

Validatentine provides additional `mustBe*()` validator functions for Matlab.
Validoozy provides additional `mustBe*()` validator functions for Matlab.
These are the input/property-validation functions introduced in Matlab R2017a.

Validatentine provides two sets of validator functions:
Validoozy provides two sets of validator functions:

* `extend` – New validator functions that Matlab does not define
* `compat` – Back-compatibility implementations of the Matlab-provided validators, for use in Matlab versions prior to R2017a, or if you want to use my "label" extension

## Usage

To use Validatentine, install the source tree somewhere on your disk, and then run `load_validatentine` from the `Mcode` directory.
To use Validoozy, install the source tree somewhere on your disk, and then run `load_validoozy` from the `Mcode` directory.

## Label extension

My validator functions provide an additional optional "`label`" argument that allows you to specify how the error message refers to the input upon validation failure.
This is useful if you are calling the validator on something besides a named variable, such as a field of a struct, or a value in a cell array.
In these cases, the validator functions are unable to automatically detect a good label via the use of `inputname`, so you can supply one manually to produce a nicer error message.

Both the "extend" and "compat" implementations in Validatentine support label arguments.
Both the "extend" and "compat" implementations in Validoozy support label arguments.
If you want to use my label extension with Matlab-defined functions in R2017a and later, stick the `Mcode/compat` directory on the front of your Matlab path, and I _think_ it will work.
I've defined all the "compat" functions to be compatible with Matlab's own implementations, for the signature forms that they define.

## License

Validatentine for Matlab is licensed under the business-friendly BSD 2-clause license.
Validoozy for Matlab is licensed under the business-friendly BSD 2-clause license.

## Project

The home page for Validatentine for Matlab is the [Validatentine GitHub repo](https://github.com/apjanke/matlab-validatentine).
The home page for Validoozy for Matlab is the [Validoozy GitHub repo](https://github.com/apjanke/matlab-validoozy).

For support, feel free to post a bug report or question on the [Validatentine GitHub issue tracker](https://github.com/apjanke/matlab-validatentine/issues).
For support, feel free to post a bug report or question on the [Validoozy GitHub issue tracker](https://github.com/apjanke/matlab-validoozy/issues).

The project author is [Andrew Janke](https://apjanke.net).

0 comments on commit 41fa6b6

Please sign in to comment.