[SciPy-Dev] Warning of deprecation in doc's ?

Vincent Davis vincent@vincentdavis....
Wed Jun 2 23:34:40 CDT 2010


On Wed, Jun 2, 2010 at 10:17 PM, Benjamin Root <ben.root@ou.edu> wrote:
> I will look into that tomorrow.  And I certainly agree that we should not
> wait until pydocweb presents us a solution.  We should certainly follow some
> sort of standard way to mark/tag/denote these deprecation warnings, that way
> 'grep' can still be a very valuable tool here.

Also when it will be deprecated would be good to know/document.

Thanks
Vincent

>
> Ben Root
>
>
>>
>> DG
>>
>>
>>>
>>> On Wed, Jun 2, 2010 at 10:07 PM, David Goldsmith
>>> <d.l.goldsmith@gmail.com> wrote:
>>>>
>>>> On Wed, Jun 2, 2010 at 7:22 PM, Vincent Davis <vincent@vincentdavis.net>
>>>> wrote:
>>>>>
>>>>> For example scipy.stats.stats.cov when you view source has
>>>>> "scipy.stats.cov is deprecated; please update your code to use
>>>>> numpy.cov." Should this be in the docs ? and is there an example of
>>>>> how this should be pointed out.
>>>>> This is something I actually implemented in a program then discovered
>>>>> that is was deprecated. I would have like that to be in the online
>>>>> docs.
>>>>>
>>>>> Thanks
>>>>> Vincent
>>>>
>>>> I vaguely recollect this being discussed before, but I can't find
>>>> anything about it in our docstring Standard, in our Q+A section, nor
>>>> (easily) at the Python site (generally, when in doubt, we default to Python
>>>> docstring standards); so, how 'bout it guys and gals: should deprecation be
>>>> noted in docstrings and if so, where and how?
>>>>
>>>> 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
>>>
>>
>>
>>
>> --
>> Mathematician: noun, someone who disavows certainty when their uncertainty
>> set is non-empty, even if that set has measure zero.
>>
>> Hope: noun, that delusive spirit which escaped Pandora's jar and, with her
>> lies, prevents mankind from committing a general suicide.  (As interpreted
>> by Robert Graves)
>>
>> _______________________________________________
>> 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