#13109: Rewrite deprecation to use trac ticket numbers
--------------------------------+-------------------------------------------
       Reporter:  vbraun        |         Owner:  mvngu   
           Type:  enhancement   |        Status:  new     
       Priority:  major         |     Milestone:  sage-5.1
      Component:  doctest       |    Resolution:          
       Keywords:                |   Work issues:          
Report Upstream:  N/A           |     Reviewers:          
        Authors:  Volker Braun  |     Merged in:          
   Dependencies:                |      Stopgaps:          
--------------------------------+-------------------------------------------
Changes (by {'newvalue': u'Volker Braun', 'oldvalue': ''}):

  * author:  => Volker Braun


Old description:

> As discussed on https://groups.google.com/d/topic/sage-
> devel/I12IeaFlE7g/discussion, change the deprecation function to the new
> arguments
> {{{
> deprecation(trac_number, message)
> }}}
> where both arguments are mandatory.  Once this code is in Sage, one
> can deduce every possible thing discussed above in this thread from
> the trac number.   The deprecation warning can produce the URL of the
> trac ticket.
>
> Analogous changes are made to `deprecated_function_alias` and
> `deprecated_callable_import`. Finally, the
> `@rename_keyword(deprecated="sage version string", ...)` decorator is
> changed to
> {{{
> @rename_keyword(deprecation=<trac_number>, ...)
> }}}
>
> Apply
>   * [attachment:trac_13109_deprecation.patch]
>   * [attachment:trac_13109_ticket_numbers.patch]
>   * [attachment:trac_13109_fix_doctests.patch]

New description:

 As discussed on https://groups.google.com/d/topic/sage-
 devel/I12IeaFlE7g/discussion, change the deprecation function to the new
 arguments
 {{{
 deprecation(trac_number, message)
 }}}
 where both arguments are mandatory.  Once this code is in Sage, one
 can deduce every possible thing discussed above in this thread from
 the trac number.   The deprecation warning can produce the URL of the
 trac ticket.

 Analogous changes are made to `deprecated_function_alias` and
 `deprecated_callable_import`. Finally, the
 `@rename_keyword(deprecated="sage version string", ...)` decorator is
 changed to
 {{{
 @rename_keyword(deprecation=<trac_number>, ...)
 }}}

 Apply
   * [attachment:trac_13109_deprecation.patch]
   * [attachment:trac_13109_ticket_numbers.patch]
   * [attachment:trac_13109_fix_doctests.patch]
   * [attachment:trac_13109_documentation.patch]

 This ticket also fixes #8073, #8546.

--

Comment:

 The last patch adds documentation to the developer guide.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13109#comment:5>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to