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

Documentation: standardize on patterns for deprecation #352

Closed
msendlakowski opened this issue Aug 15, 2018 · 2 comments
Closed

Documentation: standardize on patterns for deprecation #352

msendlakowski opened this issue Aug 15, 2018 · 2 comments
Assignees
@ianmcburnie
Labels
aspect: documentation resolution: done
Projects
4.5.0
Milestone
4.5.0

Comments

@msendlakowski
Copy link
Contributor

Feature Request

Description

We should discuss and document how we want to notify user's of deprecated features.

Context

See #346 (comment)
@ianmcburnie
Copy link
Contributor

ianmcburnie commented Oct 12, 2018 •
edited

In skin if I want to deprecate something I will usually mark it as deprecated in the code comments and release notes. I will also try and give some clue as to which major version it will be removed permanently. Usually it's the next one, but if the deprecated thing is fairly harmless or still used widely, I will leave it around longer (but removed from all documentation).

Also, if simply just renaming things, then aliases can help a lot.

@ianmcburnie ianmcburnie changed the title Standardize on patterns for deprecation Documentation: standardize on patterns for deprecation Oct 12, 2018
@ianmcburnie
Copy link
Contributor

I've added some brief notes to the docs in 4.5.0

@ianmcburnie ianmcburnie self-assigned this Nov 20, 2019
@ianmcburnie ianmcburnie added this to To do in 4.5.0 via automation Nov 20, 2019
@ianmcburnie ianmcburnie added this to the 4.5.0 milestone Nov 20, 2019
@ianmcburnie ianmcburnie moved this from To do to Done in 4.5.0 Nov 20, 2019
ianmcburnie added a commit that referenced this issue Nov 20, 2019
@ianmcburnie
Docs: added deprecation guidance #352
4d25b18
@ianmcburnie ianmcburnie mentioned this issue Nov 20, 2019
Closed
ETCaton pushed a commit that referenced this issue Dec 10, 2019
Ported documentation about deprecation (#352) upstream to 5.0.0
bd780e2 
Part of bringing 4.5.0 changes upstream to 5.0.0; see #956 for more info
@ETCaton ETCaton mentioned this issue Dec 10, 2019
Merged
agliga pushed a commit that referenced this issue Dec 10, 2019
@ETCaton @agliga
Ported documentation about deprecation (#352) upstream to 5.0.0 (#980)
1ae6cc7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ianmcburnie ianmcburnie

Labels
aspect: documentation resolution: done
Projects
No open projects
4.5.0
  
Done
Milestone
4.5.0
Development

No branches or pull requests
2 participants
@ianmcburnie @msendlakowski