Mercurial > octave-antonio
comparison scripts/time/weekday.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 |
|---|---|
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {[@var{n}, @var{s}] =} weekday (@var{d}) | 20 ## @deftypefn {Function File} {[@var{n}, @var{s}] =} weekday (@var{d}) |
| 21 ## @deftypefnx {Function File} {[@var{n}, @var{s}] =} weekday (@var{d}, @var{format}) | 21 ## @deftypefnx {Function File} {[@var{n}, @var{s}] =} weekday (@var{d}, @var{format}) |
| 22 ## Return the day of the week as a number in @var{n} and as a string in @var{s}. | 22 ## Return the day of the week as a number in @var{n} and as a string in @var{s}. |
| 23 ## | |
| 23 ## The days of the week are numbered 1--7 with the first day being Sunday. | 24 ## The days of the week are numbered 1--7 with the first day being Sunday. |
| 24 ## | 25 ## |
| 25 ## @var{d} is a serial date number or a date string. | 26 ## @var{d} is a serial date number or a date string. |
| 26 ## | 27 ## |
| 27 ## If the string @var{format} is not present or is equal to @qcode{"short"} then | 28 ## If the string @var{format} is not present or is equal to @qcode{"short"} |
| 28 ## @var{s} will contain the abbreviated name of the weekday. If @var{format} | 29 ## then @var{s} will contain the abbreviated name of the weekday. If |
| 29 ## is @qcode{"long"} then @var{s} will contain the full name. | 30 ## @var{format} is @qcode{"long"} then @var{s} will contain the full name. |
| 30 ## | 31 ## |
| 31 ## Table of return values based on @var{format}: | 32 ## Table of return values based on @var{format}: |
| 32 ## | 33 ## |
| 33 ## @multitable @columnfractions .06 .13 .16 | 34 ## @multitable @columnfractions .06 .13 .16 |
| 34 ## @headitem @var{n} @tab @qcode{"short"} @tab @qcode{"long"} | 35 ## @headitem @var{n} @tab @qcode{"short"} @tab @qcode{"long"} |