view scripts/time/date.m @ 26600:f6730533820e stable

doc: clean up doc example blocks for accuracy and consistent formatting * bitset.m, circshift.m, idivide.m, int2str.m, integral3.m, num2str.m, rat.m, repelem.m, shiftdim.m, structfun.m, trapz.m, condeig.m, cross.m, qzhess.m, computer.m, fullfile.m, orderfields.m, substruct.m, swapbytes.m, contourc.m, isprime.m, runlength.m, clock.m, date.m: Fix presentation and formatting of example block results. * graphics.cc (Fset): Likewise. * sparse.cc (Fsparse): Likewise.
author Mike Miller <mtmiller@octave.org>
date Tue, 22 Jan 2019 13:45:11 -0800
parents 00f796120a6d
children 4d6d21839dfd
line wrap: on
line source

## Copyright (C) 1995-2019 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
## <https://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {} {} date ()
## Return the current date as a character string in the form DD-MMM-YYYY@.
##
## For example:
##
## @example
## @group
## date ()
##   @result{} 20-Aug-1993
## @end group
## @end example
## @seealso{now, clock, datestr, localtime}
## @end deftypefn

## Author: jwe

function retval = date ()

  if (nargin != 0)
    print_usage ();
  endif

  retval = strftime ("%d-%b-%Y", localtime (time ()));

endfunction


%!assert (strcmp (date (), strftime ("%d-%b-%Y", localtime (time ()))))

## Test input validation
%!error date (1)