Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document a deprecation policy #1508

Closed
ambrosejcarr opened this issue Aug 26, 2019 · 5 comments
Closed

Document a deprecation policy #1508

ambrosejcarr opened this issue Aug 26, 2019 · 5 comments
Assignees
@ttung

Comments

@ambrosejcarr
Copy link
Member

Objective

As a starfish user, I want adequate warning to know when the API will change so that I can keep my code up to date with starfish

Acceptance Criteria

  • Document a deprecation policy and put it into use.
@shanaxel42
Copy link
Collaborator

shanaxel42 commented Aug 26, 2019 •
edited
Loading

@ttung thinks we should make a lis of apis we plan on deprecating in addition to this.

@shanaxel42
Copy link
Collaborator

@neuromusic mentioned we could add deprecation comments to docstrings inspired by the way numpy does it.

@ambrosejcarr
Copy link
Member Author

See e.g. https://github.com/spacetx/starfish/pull/1390/files

@neuromusic
Copy link
Collaborator

here's what I was looking for ...

@ambrosejcarr
Copy link
Member Author

  • 2 months between deprecation warning and removal
  • Add examination of previous deprecations to release checklist (review of changelog for previous releases)
  • do we need a commit template?

@ttung ttung mentioned this issue Sep 3, 2019
Merged
ttung pushed a commit that referenced this issue Sep 16, 2019
Bring existing deprecated methods in compliance with deprecation policy.
e0a791e 
Add a ..deprecated:: docstring.  This will serve as a helpful example next time someone wants to deprecate something.

Part of #1508
ttung pushed a commit that referenced this issue Sep 16, 2019
Bring existing deprecated methods in compliance with deprecation poli…
54c2a69 
…cy. (#1529)

Add a ..deprecated:: docstring.  This will serve as a helpful example next time someone wants to deprecate something.

Part of #1508
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ttung ttung

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ttung @neuromusic @ambrosejcarr @shanaxel42