[SciPy-dev] ndimage - docfiller and output_type

[Ralf Gommers]

On Mon, Oct 12, 2009 at 8:51 PM, Ralf Gommers
<ralf.gommers at googlemail.com>wrote:

> Hi all,
>
> While working on the ndimage docs, I saw that the docfiller decorator in
> ndimage.filters does not work well with the doc wiki. Basically, in the doc
> wiki you see the docstring with the decorator applied. Then if you make an
> edit, all the %(param) markup has been replaced. Compare the `convolve` and
> `convolve1d` docstrings in trunk to see what happens.
>
> Some options to fix this:
> 1. remove the filters docstrings from the doc wiki
> 2. make the doc wiki understand the decorator
> 3. remove the decorator, and do some copy-paste'ing of parameter
> descriptions
> 4. remove the decorator, and refer to a single description of those
> parameters outside the docstring.
>
> I would have a preference for 3 or 4, mostly because it's easier and more
> robust. Would you like a patch for either of those options?
>
> Update: someone decided to work on the filters docs last night during the
sprint, so the @docfiller markup will be wiped out by the next doc merge
unless we decide it is important and fix it.

Also see this related ticket:
http://code.google.com/p/pydocweb/issues/detail?id=33

Cheers,
Ralf

>
>
> Cheers,
> Ralf
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20091025/9143b2e1/attachment.html>