[Pkg-octave-devel] Bug#296973: octave-forge: weekday has incorrect documentation

[Bill Denney]

Package: octave-forge
Version: 2004.11.16-3
Severity: minor

The weekday function has incorrect documentation.  Its documentation 
appears to be a copy of datevec's documentation.  The doc at the 
beginning should read something like:

--- Begin Documentation
## -*- texinfo -*-
## @deftypefn {Function File} {[d,s] =} weekday(date, [P])
## Takes a date (in either datenum format or a string that datenum can
## parse) and returns the number for the day of the week (0 = "Sun", 
## 1 = "Mon", ... , "Sat")
##
## The parameter @code{P} is needed to convert date strings with 2 digit
## years into dates with 4 digit years.  2 digit years are assumed to be
## between @code{P} and @code{P+99}. If @code{P} is not given then the 
## current year - 50 is used, so that dates are centered on the present.
## For birthdates, you would want @code{P} to be current year - 99.  For
## appointments, you would want @code{P} to be current year.
##
## @seealso{date,clock,now,datestr,datenum,datevec,calendar} 
## @end deftypefn
--- End Documentation

Hopefully, I'll be able to submit a patch that will help with making 
datevec accept strings soon, too.

Bill

-- System Information:
Debian Release: 3.1
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: i386 (i686)
Kernel: Linux 2.6.8-2-686
Locale: LANG=en_US, LC_CTYPE=en_US (charmap=ISO-8859-1)

Versions of packages octave-forge depends on:
ii  atlas3-base [liblapack.s 3.6.0-19        Automatically Tuned Linear Algebra
ii  fftw3                    3.0.1-11        Library for computing Fast Fourier
ii  libc6                    2.3.2.ds1-20    GNU C Library: Shared libraries an
ii  libcln3                  1.1.9-1         Class Library for Numbers (C++)
ii  libg2c0                  1:3.3.5-8       Runtime library for GNU Fortran 77
ii  libgcc1                  1:3.4.3-6       GCC support library
ii  libginac1.3              1.3.0-2         The GiNaC framework (runtime libra
ii  libgmp3                  4.1.4-5         Multiprecision arithmetic library
ii  libgsl0                  1.6-1           The GNU Scientific Library (GSL) -
ii  libhdf5-serial-1.6.2-0 [ 1.6.2-3         Hierarchical Data Format 5 (HDF5) 
ii  libice6                  4.3.0.dfsg.1-10 Inter-Client Exchange library
ii  libjpeg62                6b-9            The Independent JPEG Group's JPEG 
ii  libncurses5              5.4-4           Shared libraries for terminal hand
ii  libpng12-0               1.2.8rel-1      PNG library - runtime
ii  libqhull5                2003.1-1        Calculate convex hulls and related
ii  libreadline4             4.3-11          GNU readline and history libraries
ii  libsm6                   4.3.0.dfsg.1-10 X Window System Session Management
ii  libstdc++5               1:3.3.5-8       The GNU Standard C++ Library v3
ii  libx11-6                 4.3.0.dfsg.1-10 X Window System protocol client li
ii  octave2.1                2.1.64-1        The GNU Octave language for numeri
ii  xlibs                    4.3.0.dfsg.1-10 X Keyboard Extension (XKB) configu
ii  zlib1g                   1:1.2.2-3       compression library - runtime

-- no debconf information