Opened 5 years ago

Closed 5 years ago

#17871 closed enhancement (fixed)

Rephrase the 'deprecation' section of the developer's manual

Reported by: ncohen Owned by:
Priority: major Milestone: sage-6.6
Component: documentation Keywords:
Cc: kcrisman, vdelecroix Merged in:
Authors: Nathann Cohen Reviewers: Frédéric Chapoton
Report Upstream: N/A Work issues:
Branch: 76fdfac (Commits) Commit: 76fdfaceafee00c638bc1368925b714b1ed536d3
Dependencies: Stopgaps:

Description

This ticket rephrases the 'deprecation' section of the developer's manual to list the different types of deprecation and the tools that we have to deal with them.

It also adds superseded.py to the reference manual. Quite surprisingly, it was never included.

Nathann

Change History (13)

comment:1 Changed 5 years ago by ncohen

  • Branch set to public/17871
  • Commit set to a73afb2e0bc3f7f402064b0d5714791b9a802e1f
  • Dependencies #17868 deleted
  • Status changed from new to needs_review

New commits:

a73afb2trac #17871; Rephrase the 'deprecation' section of the developer's manual

comment:2 follow-up: Changed 5 years ago by chapoton

The name of the old function is missing in

my_old_function = deprecated_function_alias()

The last example is not very good, it does not explain where to put deprecation. In the first line of the function ?

comment:3 Changed 5 years ago by git

  • Commit changed from a73afb2e0bc3f7f402064b0d5714791b9a802e1f to def8ff7c8fd059c67f3b786a5e9e1e6856254012

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

9e674edtrac #17871; Rephrase the 'deprecation' section of the developer's manual
def8ff7trac #17871: Reviewer's comment

comment:4 in reply to: ↑ 2 Changed 5 years ago by ncohen

Helloooooooooooo !

The last example is not very good, it does not explain where to put deprecation. In the first line of the function ?

I rephrased it a bit... What do you think?

I also rebased the former commit on top of the latest beta.

Nathann

comment:5 Changed 5 years ago by chapoton

Why is there

+
+Functions and classes
+---------------------

in superseded.py ?

comment:6 Changed 5 years ago by ncohen

Oh. Well, because otherwise the module's doc is immediately followed by the auto-generated documentation for the classes/functions contained in the object. I find it prettier like this, but if you object it can be removed.

Nathann

comment:7 Changed 5 years ago by chapoton

  • Reviewers set to Frédéric Chapoton
  • Status changed from needs_review to positive_review

ok, I understand.

I think that this looks good enough.

comment:8 Changed 5 years ago by chapoton

  • Status changed from positive_review to needs_work

oops, one second. Could you add the missing trac roles in superseded.py, please.

Then put back to pos rev

comment:9 Changed 5 years ago by git

  • Commit changed from def8ff7c8fd059c67f3b786a5e9e1e6856254012 to 76fdfaceafee00c638bc1368925b714b1ed536d3

Branch pushed to git repo; I updated commit sha1. New commits:

76fdfactrac #17871: missing trac role

comment:10 Changed 5 years ago by ncohen

  • Status changed from needs_work to positive_review

I found only one ?...

Nathann

comment:11 Changed 5 years ago by chapoton

yes, yes, there was only one. Sorry for the "s", I was trying to type fast.

comment:12 Changed 5 years ago by ncohen

Okayyyy, fine then :-)

Nathann

comment:13 Changed 5 years ago by vbraun

  • Branch changed from public/17871 to 76fdfaceafee00c638bc1368925b714b1ed536d3
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.