[SciPy-dev] Latex and docstrings

josef.pktd@gmai... josef.pktd@gmai...
Fri Feb 19 06:24:28 CST 2010


On Fri, Feb 19, 2010 at 2:45 AM, Tom Grydeland <tom.grydeland@gmail.com> wrote:
> On Fri, Feb 19, 2010 at 7:10 AM,  <josef.pktd@gmail.com> wrote:
>
>> I created a stub tutorial page for fftpack,
>> http://docs.scipy.org/scipy/docs/scipy-docs/tutorial/fftpack.rst/
>> and copied the last correct latex version for dct.
>> I latex math doesn't render, so I changed the first two equations to
>> the same pattern as the equations are in the signal tutorial which
>> works. I also copied the first paragraph from the numpy fft module
>> description.,
>
> Thanks Josef!
>
> If the DCT matter is right for a tutorial, I believe a lot more of the
> numpy.fft module description would fit also.
>
> Do you want me to fix the latex errors?

Yes, please, and make any adjustment that you find usefule.

One formatting: I think the header ordering is === ----- ^^^^^ ~~~  ,
if my inference from other rst pages is correct.
Because I don't know what the section hierarchy might be, I didn't
change to the correct underlines for headers of  subsections.

I didn't want to copy too much from the numpy docs since we can also
just refer to it. For my reading an abridged explanation refering to
the numpy docs, and a more complete collection of the extra parts that
in scipy would be useful. But we haven't had much discussion yet on
doc duplication between scipy and numpy (which is also relevant for
the descriptions of the distributions in numpy.random and
scipy.stats.distributions)

Thanks,

Josef

>
>> Josef
>
> --
> Tom Grydeland
>  <Tom.Grydeland@(gmail.com)>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>


More information about the SciPy-Dev mailing list