[SciPy-dev] Scipy Tutorial (and updating it)
Tue Dec 9 03:50:37 CST 2008
> 2008/12/9 Pauli Virtanen <firstname.lastname@example.org>:
>> 2008/12/8 Tom Grydeland <email@example.com>: Just to get my hands
>> The first problem I ran into is that there is no way to tell the
>> documentation system that I am documenting a class instance, so the
>> "Parameters" and "Returns" sections are both mandatory, while only the
>> latter actually makes sense. I see there is some specal handling of
>> class documentation, which might work for objects (instances) also,
>> perhaps with some modifications?
> Note that `mgrid` is an object and not a class; class documentation is
> already handled. We don't have a standard for objects, so the parser
> assumes the format is the same as for functions.
My mistake, I missed that.
>> Another problem is that the "See Also" entries are not showing up as
>> cross-references (or even as a dictionary list). What did I miss?
> The See Also section won't work if the whole docstring is not formatted
> per the standard. Could be fixed, yes.
It would be nice if it worked. It causes problems in a few other
places e.g. http://docs.scipy.org/numpy/docs/numpy.core.records.recarray/
where the "Other Parameters" section isn't recognized.
More information about the Scipy-dev