Ticket #3264 enhancement closed worksforme

Opened 6 years ago

Last modified 4 years ago

Summarize deprecation policy for Twisted developers

Reported by: jml Owned by:
Priority: normal Milestone:
Component: release management Keywords: deprecation-policy, documentation
Cc: thijs, jesstess Branch:
Author: Launchpad Bug:

Description

The new deprecation policy (see #3263) needs to be summarized for people who work on Twisted. A good place to put this summary is in the coding standard.

I'm not sure if we have a checklist for reviewers -- if we do, it should go there also.

Change History

1

follow-up: ↓ 3   Changed 6 years ago by jml

It should answer questions:

  • How do I add a deprecation?
  • When can I remove it?

2

  Changed 5 years ago by thijs

  • owner changed from jml to thijs
  • cc thijs added
  • status changed from new to assigned

3

in reply to: ↑ 1   Changed 5 years ago by thijs

  • status changed from assigned to new
  • keywords deprecation-policy, documentation, review added; deprecation-policy documentation removed
  • owner thijs deleted

Replying to jml:

It should answer questions: * How do I add a deprecation? * When can I remove it?

Putting it up for review so somebody can take a shot at answering these questions so they can be documented.

4

  Changed 5 years ago by mwh

This approach doesn't seem to be working.

5

  Changed 5 years ago by jml

  • keywords documentation added; documentation, review removed

There isn't anything to review here, and as mwh said, putting it up for review in order to get answers doesn't seem to be working either. Removing the 'review' tag.

6

  Changed 4 years ago by jesstess

  • cc jesstess added

7

  Changed 4 years ago by exarkun

I added < http://twistedmatrix.com/trac/wiki/CompatibilityPolicy#HowtodeprecateAPIs>. It's not great, it's probably wrong and/or incomplete. It's a start, though. We can work on it on the wiki for a while and then turn it into something for the coding standard, I guess.

8

  Changed 4 years ago by frap

  • status changed from new to closed
  • resolution set to worksforme

I´ve read the deprecate API wiki. Seems to me to make sense. I think we should close this ticket and any enhancements just work through updating the wiki instead of raising tickets for simple docs - as clutters ticket system and adds unneccesary overhead that takes longer than reading and editing the wiki

9

  Changed 3 years ago by <automation>

Note: See TracTickets for help on using tickets.