Mercurial > octave
diff scripts/miscellaneous/mustBeInteger.m @ 28722:a2177e663979 stable
doc: Use standard verb phrasing in mustBe* functions and add @seealso links.
* mustBeFinite.m, mustBeGreaterThan.m, mustBeGreaterThanOrEqual.m,
mustBeInteger.m, mustBeLessThan.m, mustBeLessThanOrEqual.m, mustBeMember.m,
mustBeNegative.m, mustBeNonNan.m, mustBeNonempty.m, mustBeNonnegative.m,
mustBeNonpositive.m, mustBeNonsparse.m, mustBeNonzero.m, mustBeNumeric.m,
mustBeNumericOrLogical.m, mustBePositive.m, mustBeReal.m:
Use standard verb phrasing and add @seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 11 Sep 2020 15:39:17 -0700 |
| parents | a9a8699a3749 |
| children | dd9efd873596 |
line wrap: on
line diff
--- a/scripts/miscellaneous/mustBeInteger.m Fri Sep 11 18:36:27 2020 -0400 +++ b/scripts/miscellaneous/mustBeInteger.m Fri Sep 11 15:39:17 2020 -0700 @@ -26,12 +26,13 @@ ## -*- texinfo -*- ## @deftypefn {} {} mustBeInteger (@var{x}) ## -## Requires that input @var{x} is integer-valued (but not necessarily +## Require that input @var{x} is integer-valued (but not necessarily ## integer-typed). ## -## Raises an error if any element of the input @var{x} is not a finite, +## Raise an error if any element of the input @var{x} is not a finite, ## real, integer-valued numeric value, as determined by various checks. ## +## @seealso{mustBeNumeric} ## @end deftypefn function mustBeInteger (x)