Mercurial > octave-nkf
comparison scripts/time/is_leap_year.m @ 20197: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 | 4197fc428c7d |
| children |
comparison
equal
deleted
inserted
replaced
| 20195:03b9d17a2d95 | 20197:2645f9ef8c88 |
|---|---|
| 17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} is_leap_year () | 20 ## @deftypefn {Function File} {} is_leap_year () |
| 21 ## @deftypefnx {Function File} {} is_leap_year (@var{year}) | 21 ## @deftypefnx {Function File} {} is_leap_year (@var{year}) |
| 22 ## Return true if @var{year} is a leap year and false otherwise. If no | 22 ## Return true if @var{year} is a leap year and false otherwise. |
| 23 ## year is specified, @code{is_leap_year} uses the current year. | 23 ## |
| 24 ## If no year is specified, @code{is_leap_year} uses the current year. | |
| 25 ## | |
| 24 ## For example: | 26 ## For example: |
| 25 ## | 27 ## |
| 26 ## @example | 28 ## @example |
| 27 ## @group | 29 ## @group |
| 28 ## is_leap_year (2000) | 30 ## is_leap_year (2000) |