comparison scripts/time/datenum.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 e9f89866074c
children df437a52bcaf
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
73 ## 73 ##
74 ## @item 74 ## @item
75 ## Days can be fractional. 75 ## Days can be fractional.
76 ## @end itemize 76 ## @end itemize
77 ## 77 ##
78 ## @strong{Caution:} this function does not attempt to handle Julian 78 ## @strong{Caution:} this function does not attempt to handle Julian calendars so dates before October 15, 1582 are wrong by as much as eleven days. Also, be aware that only Roman Catholic countries adopted the calendar in 1582. It took until 1924 for it to be adopted everywhere. See the Wikipedia entry on the Gregorian calendar for more details.
79 ## calendars so dates before October 15, 1582 are wrong by as much 79 ##
80 ## as eleven days. Also, be aware that only Roman Catholic countries 80 ## @strong{Warning:} leap seconds are ignored. A table of leap seconds is available on the Wikipedia entry for leap seconds.
81 ## adopted the calendar in 1582. It took until 1924 for it to be
82 ## adopted everywhere. See the Wikipedia entry on the Gregorian
83 ## calendar for more details.
84 ##
85 ## @strong{Warning:} leap seconds are ignored. A table of leap seconds
86 ## is available on the Wikipedia entry for leap seconds.
87 ## @seealso{datestr, datevec, now, clock, date} 81 ## @seealso{datestr, datevec, now, clock, date}
88 ## @end deftypefn 82 ## @end deftypefn
89 83
90 ## Algorithm: Peter Baum (http://vsg.cape.com/~pbaum/date/date0.htm) 84 ## Algorithm: Peter Baum (http://vsg.cape.com/~pbaum/date/date0.htm)
91 ## Author: pkienzle <pkienzle@users.sf.net> 85 ## Author: pkienzle <pkienzle@users.sf.net>