[SciPy-dev] ndimage - docfiller and output_type

josef.pktd at gmail.com josef.pktd at gmail.com
Wed Oct 28 15:34:58 EDT 2009


On Wed, Oct 28, 2009 at 2:07 PM, Pauli Virtanen <pav+sp at iki.fi> wrote:
> Wed, 28 Oct 2009 11:13:10 -0400, josef.pktd wrote:
> [clip]
>> No, I like the current system where we don't have any boiler plate in
>> the individual distributions. Following your maxwell example, we would
>> get a lot of repetition of template code in the individual
>> distributions.
>
> Then, I'd suggest just adding
>
>        %(info)s
>
> or so, that will be expanded to the full boilerplate information block.
> Then, only this would be repeated in each distribution docstring -- not
> too bad.

If you can do it with minimal code/text duplication, then any way is fine
with me.

>
> It is clearer and cleaner if the distribution docstring is a template,
> resides in the class docstring, and the final product is assembled by
> substitution rather than by concatenating magically generated parts.
> (Think, for example -- why are HTML templating languages so popular, as
> opposed to just concatenating blocks of HTML code?)

The last time I looked at mako, it allowed full inheritance and backward (?)
substitution in the templates.

I don't see how template inheritance would work with simple string
substitution, but you are the experts for the numpy/scipy documentation
system.

Josef


>
> --
> Pauli Virtanen
>
> _______________________________________________
> Scipy-dev mailing list
> Scipy-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>



More information about the SciPy-Dev mailing list