[SciPy-Dev] stats some further clean up

nicky van foreest vanforeest@gmail....
Thu Sep 13 13:46:51 CDT 2012


Hi Josef,

On 11 September 2012 16:03,  <josef.pktd@gmail.com> wrote:
> On Tue, Sep 11, 2012 at 9:46 AM, nicky van foreest <vanforeest@gmail.com> wrote:
>> Hi,
>>
>> distributions.py contains some #hashed documentation from lines
>>
>> https://github.com/nokfi/scipy/blob/master/scipy/stats/distributions.py#L509
>>
>> to
>>
>> https://github.com/nokfi/scipy/blob/master/scipy/stats/distributions.py#L598
>>
>> I would prefer to remove it as some parts should better fit  in the
>> documentation at
>> http://docs.scipy.org/doc/scipy/reference/tutorial/stats/continuous.html#continuous-random-variables
>> while a lot is already covered in the standard doc strings of
>> rv_continuous and rv_discrete. Should I just go ahead, or first make a
>> somewhat more specified list of what I intend to do?
>
> Do we need module maintainer notes that are too much for the user
> facing documentation?

I don't quite get what you mean by this. Is it still relevant in view
of my latest pull request about the documentation?

> I often keep some under triple quotes at the top of a module.

Sure, but the lines I referred are simply in overlap with other
docstrings. Hence, from the DRY principle, it is better to remove it
IMO.

Nicky

>
> You're the latest to figure out distributions.py and might know what
> additional information is helpful.
>
> Josef
>
>>
>> nicky
>> _______________________________________________
>> SciPy-Dev mailing list
>> SciPy-Dev@scipy.org
>> http://mail.scipy.org/mailman/listinfo/scipy-dev
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev


More information about the SciPy-Dev mailing list