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.

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

Add docs for deprecated functions #4

Closed
timrwood opened this issue Mar 23, 2012 · 3 comments
Closed

Add docs for deprecated functions #4

timrwood opened this issue Mar 23, 2012 · 3 comments

Comments

@timrwood
Copy link
Member

moment.meridiem.am/AM/pm/PM
moment/moment#228

moment.fn.native
moment/moment#216

moment.format('z zz')
moment/moment#227

@rockymeza
Copy link

Perhaps we need to establish a deprecation policy for functionality? It would be a pretty bad surprise if a certain piece of functionality just disappeared without notice. Do you think one minor release number between notice of deprecation and removal of functionality is enough?

Additionally, I think the documentation for the deprecated feature should stay up, but only to explain how to update code or to work around the missing feature.

What do you think?

@timrwood
Copy link
Member Author

timrwood commented Apr 2, 2012

Yeah, I think 1 minor release should be enough time. It tends to be about a month and a half or so between releases. Do you think it's too late now to deprecate for 1.6? 1.5 released March 19, so if we get the docs up now, it will be about month until the 1.6 release.

I think we should also make upgrade path notes either on the changelog on the github readme, or in the docs themselves. The only communication we have are those and the twitter account, but the twitter account has very few followers, so that's not really reliable.

You can see an example of the upgrade notes I added in the past on the readme here https://github.com/timrwood/moment/tree/0.6.0

@rockymeza
Copy link

I think that since we've already removed some functionality, let's go ahead and leave it removed in 1.6, but I think if we remove any more functionality, that it should still work until 1.7. Does that sound good?

I would probably look at the changelog for upgrade paths actually. I don't think Twitter is a viable place to put upgrade paths, especially because I'm in China right now. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants