Mercurial > octave-nkf
view scripts/time/asctime.m @ 20527:635c93bba6b6 stable
doc: Make excplicit that asctime and ctime values end in a newline (bug #45976)
* asctime.m, ctime.m: Update docstrings to show trailing newline in the returned
string. Add %!tests.
author | Mike Miller <mtmiller@octave.org> |
---|---|
date | Sun, 20 Sep 2015 11:27:36 +0200 |
parents | 2645f9ef8c88 |
children |
line wrap: on
line source
## Copyright (C) 1995-2015 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} asctime (@var{tm_struct}) ## Convert a time structure to a string using the following ## format: @qcode{"ddd mmm mm HH:MM:SS yyyy@xbackslashchar{}n"}. ## ## For example: ## ## @example ## @group ## asctime (localtime (time ())) ## @result{} "Mon Feb 17 01:15:06 1997@xbackslashchar{}n" ## @end group ## @end example ## ## This is equivalent to @code{ctime (time ())}. ## @seealso{ctime, localtime, time} ## @end deftypefn ## Author: jwe function retval = asctime (tm_struct) if (nargin != 1) print_usage (); endif retval = strftime ("%a %b %d %H:%M:%S %Y\n", tm_struct); endfunction %!test %! t = time (); %! assert (strcmp (asctime (localtime (t)), ctime (t))); %!assert (asctime (localtime (time ()))(end), "\n") %!error asctime () %!error asctime (1, 2)