Changeset 1163

Show
Ignore:
Timestamp:
07/26/08 09:19:47 (4 months ago)
Author:
mattknox_ca
Message:

doc string updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/timeseries/scikits/timeseries/src/c_dates.c

    r1043 r1163  
    15861586 
    15871587static char DateObject_asfreq_doc[] = 
    1588 "Returns a date converted to a specified frequency.\n\n" 
    1589 "*Parameters*:\n" 
    1590 "    freq : {freq_spec}\n" 
    1591 "        Frequency to convert the Date to. Accepts any valid frequency\n" 
    1592 "        specification (string or integer)\n" 
    1593 "    relation : {'END', 'START'} (optional)\n" 
    1594 "        Applies only when converting a lower frequency Date to a higher\n" 
    1595 "        frequency Date, or when converting a weekend Date to a business\n" 
    1596 "        frequency Date. Valid values are 'START' and 'END'."; 
     1588"   asfreq(freq, relation='END')\n" 
     1589"\n" 
     1590"   Returns a date converted to a specified frequency.\n" 
     1591"\n" 
     1592"   Parameters\n" 
     1593"   ----------\n" 
     1594"   freq : {freq_spec}\n" 
     1595"      Frequency to convert the Date to. Accepts any valid frequency\n" 
     1596"      specification (string or integer)\n" 
     1597"\n" 
     1598"   relation : {'END', 'START'} (optional)\n" 
     1599"      Applies only when converting a lower frequency Date to a higher\n" 
     1600"      frequency Date, or when converting a weekend Date to a business\n" 
     1601"      frequency Date. Valid values are 'START' and 'END'. For example, if you\n" 
     1602"      converting a monthly date to daily frequency, relation='START' will\n" 
     1603"      give you the first day of the month while relation='END' will give\n" 
     1604"      you the last day of the month.\n" 
     1605"\n" 
     1606"   Examples\n" 
     1607"   --------\n" 
     1608"   >>> D = ts.Date('D', year=2007, month=12, day=31)\n" 
     1609"   >>> D.asfreq('M')\n" 
     1610"   <M: Dec-2006>\n" 
     1611"   >>> D.asfreq('M').asfreq('D', relation='START')\n" 
     1612"   <D: 01-Dec-2006>\n" 
     1613"   >>> D.asfreq('M').asfreq('D', relation='END')\n" 
     1614"   <D: 31-Dec-2006>\n"; 
     1615 
    15971616static PyObject * 
    15981617DateObject_asfreq(DateObject *self, PyObject *args, PyObject *kwds) 

  • trunk/timeseries/scikits/timeseries/src/cseries.c

    r1043 r1163  
    2525    {"now", (PyCFunction)c_dates_now, 
    2626     METH_VARARGS, 
    27         "Returns the current date/time, at the given frequency\n\n" 
    28         "*Parameters*:\n" 
    29         "   freq : {freq_spec}\n" 
    30         "       Frequency to convert the Date to. Accepts any valid frequency\n" 
    31         "       specification (string or integer)\n"}, 
     27        "now(freq)\n" 
     28        "\n" 
     29        "Returns the current date/time, at the given frequency\n" 
     30        "\n" 
     31        "Parameters\n" 
     32        "----------\n" 
     33        "freq : {freq_spec}\n" 
     34        "   Frequency to convert the Date to. Accepts any valid frequency\n" 
     35        "   specification (string or integer)\n"}, 
    3236 
    3337    {"check_freq", (PyCFunction)c_dates_check_freq,