Mercurial > octave
changeset 24933:75a748cb08a6 stable
doc: end first sentences of doc strings with a period (bug #53388)
* file-io.cc (Fferror): End first sentence of doc string with a period.
* zscore.m: Likewise.
| author | Mike Miller <mtmiller@octave.org> |
|---|---|
| date | Mon, 19 Mar 2018 18:20:53 -0700 |
| parents | e178a73af18e |
| children | 1db0b81efafe |
| files | libinterp/corefcn/file-io.cc scripts/statistics/zscore.m |
| diffstat | 2 files changed, 2 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/file-io.cc Mon Mar 19 18:18:24 2018 -0700 +++ b/libinterp/corefcn/file-io.cc Mon Mar 19 18:20:53 2018 -0700 @@ -2649,7 +2649,7 @@ @deftypefn {} {@var{msg} =} ferror (@var{fid}) @deftypefnx {} {[@var{msg}, @var{err}] =} ferror (@var{fid}) @deftypefnx {} {[@dots{}] =} ferror (@var{fid}, "clear") -Query the error status of the stream specified by file descriptor @var{fid} +Query the error status of the stream specified by file descriptor @var{fid}. If an error condition exists then return a string @var{msg} describing the error. Otherwise, return an empty string @qcode{""}.
--- a/scripts/statistics/zscore.m Mon Mar 19 18:18:24 2018 -0700 +++ b/scripts/statistics/zscore.m Mon Mar 19 18:20:53 2018 -0700 @@ -21,7 +21,7 @@ ## @deftypefnx {} {@var{z} =} zscore (@var{x}, @var{opt}) ## @deftypefnx {} {@var{z} =} zscore (@var{x}, @var{opt}, @var{dim}) ## @deftypefnx {} {[@var{z}, @var{mu}, @var{sigma}] =} zscore (@dots{}) -## Compute the Z score of @var{x} +## Compute the Z score of @var{x}. ## ## If @var{x} is a vector, subtract its mean and divide by its standard ## deviation. If the standard deviation is zero, divide by 1 instead.