Mercurial > octave-antonio
comparison scripts/time/datevec.m @ 20162:2645f9ef8c88 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed specfun, special-matrix, testfun, and time script directories.
* scripts/specfun/expint.m, scripts/specfun/isprime.m,
scripts/specfun/legendre.m, scripts/specfun/primes.m,
scripts/specfun/reallog.m, scripts/specfun/realsqrt.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m,
scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m,
scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m,
scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m,
scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m,
scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m,
scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m,
scripts/testfun/rundemos.m, scripts/testfun/runtests.m,
scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m,
scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m,
scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m,
scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 17:00:11 -0700 |
| parents | 9fc020886ae9 |
| children |
comparison
equal
deleted
inserted
replaced
| 20160:03b9d17a2d95 | 20162:2645f9ef8c88 |
|---|---|
| 29 ## month, day, hour, minute, and seconds respectively. | 29 ## month, day, hour, minute, and seconds respectively. |
| 30 ## | 30 ## |
| 31 ## @var{f} is the format string used to interpret date strings | 31 ## @var{f} is the format string used to interpret date strings |
| 32 ## (see @code{datestr}). If @var{date} is a string, but no format is | 32 ## (see @code{datestr}). If @var{date} is a string, but no format is |
| 33 ## specified, then a relatively slow search is performed through various | 33 ## specified, then a relatively slow search is performed through various |
| 34 ## formats. It is always preferable to specify the format string @var{f} | 34 ## formats. It is always preferable to specify the format string @var{f} if it |
| 35 ## if it is known. Formats which do not specify a particular time component | 35 ## is known. Formats which do not specify a particular time component will |
| 36 ## will have the value set to zero. Formats which do not specify a date will | 36 ## have the value set to zero. Formats which do not specify a date will |
| 37 ## default to January 1st of the current year. | 37 ## default to January 1st of the current year. |
| 38 ## | 38 ## |
| 39 ## @var{p} is the year at the start of the century to which two-digit years | 39 ## @var{p} is the year at the start of the century to which two-digit years |
| 40 ## will be referenced. If not specified, it defaults to the current year | 40 ## will be referenced. If not specified, it defaults to the current year minus |
| 41 ## minus 50. | 41 ## 50. |
| 42 ## @seealso{datenum, datestr, clock, now, date} | 42 ## @seealso{datenum, datestr, clock, now, date} |
| 43 ## @end deftypefn | 43 ## @end deftypefn |
| 44 | 44 |
| 45 ## Algorithm: Peter Baum (http://vsg.cape.com/~pbaum/date/date0.htm) | 45 ## Algorithm: Peter Baum (http://vsg.cape.com/~pbaum/date/date0.htm) |
| 46 | 46 |