Changes between Version 4 and Version 5 of ApiDeprecation

Show
Ignore:
Timestamp:
06/20/08 03:04:09 (5 years ago)
Author:
rkern
Comment:

Clarified deprecation policy.

Legend:

Unmodified
Added
Removed
Modified
  • ApiDeprecation

    v4 v5  
    66 * change of default value for an argument 
    77 
    8 Adding arguments is ok, though. 
     8Adding arguments is okay, though. 
    99 
    1010= Deprecating API =  
    1111 
    12 There is a deprecation system to deprecate function in numpy.lib.utils. When deprecating a function in a version N.M.x, it will be removed in N.M+1.0 
     12Deprecated uses should issue a !DeprecationWarning using the [http://docs.python.org/lib/module-warnings.html standard library's warnings module]. There are two decorators {{{deprecate()}}} and {{{deprecate_with_doc()}}} in numpy.lib.utils for conveniently deprecating an entire function. 
     13 
     14Deprecation warnings should exist for one full minor release cycle before the deprecated features are removed, certainly no less and preferably no more. For example, if a function is deprecated in numpy 1.1.0, it will remain so in all 1.1.x releases, but it can and should be removed in 1.2.0.