[SciPy-dev] Proposed generic docstring for attributes of class generic

David Goldsmith d.l.goldsmith@gmail....
Wed Oct 21 12:29:21 CDT 2009


On Wed, Oct 21, 2009 at 10:14 AM, Ralf Gommers
<ralf.gommers@googlemail.com>wrote:

>
>
> On Wed, Oct 21, 2009 at 6:52 PM, David Goldsmith <d.l.goldsmith@gmail.com>wrote:
>
>> On Tue, Oct 20, 2009 at 2:56 AM, Ralf Gommers <
>> ralf.gommers@googlemail.com> wrote:
>>
>>>
>>> On Thu, Oct 15, 2009 at 12:38 AM, David Goldsmith <
>>> d.l.goldsmith@gmail.com> wrote:
>>>
>>>> Short summary: Not implemented (virtual attribute)
>>>>
>>>> Extended summary: Class generic exists solely to derive numpy scalars
>>>> from, and possesses, albeit unimplemented, all the attributes of the ndarray
>>>> class so as to provide a uniform API.
>>>
>>>
>>>> See Also: the corresponding attribute of the derived class of interest.
>>>>
>>>> Comments?
>>>>
>>>
>>> I saw you put this in the wiki already. One thing that is wrong is the
>>> See Also on each page, instead of the default text it needs the right link,
>>> i.e. for numpy.generic.sum refer to ndarray.sum.
>>>
>>
>> Umm, why, exactly?  Generic is the base class for scalars and doesn't
>> really have anything to do w/ ndarray.
>>
>
> Just saying that it makes no sense to have broken links in html docs. Look
> at it here:
> http://docs.scipy.org/numpy/docs/numpy.generic.sum/
>
> See Also can be deleted or fixed, either one is fine with me.
>

Ah, gotchya.  OK, not that it appears to be attracting much attention, but
I'll make this a question - what to do about these particular broken links -
on the Q & A page and see if anyone notices...

DG


>
> Cheers,
> Ralf
>
>
>>
>>  Other than that I have no idea. Please ask again during the sprint if you
>>> don't get a better answer.
>>>
>>
>> As you yourself have observed, I can ask 'til I'm blue in the face, but I
>> don't think I'm going to get anyone who knows better than the people who've
>> already read the docstring on scipy-dev.
>>
>> DG
>>
>>>
>>> Cheers,
>>> Ralf
>>>
>>>
>>>> DG
>>>>
>>>> _______________________________________________
>>>> 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
>>>
>>>
>>
>> _______________________________________________
>> 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
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20091021/8ef5d3f6/attachment.html 


More information about the Scipy-dev mailing list