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 deprecation policy #76

Open
benoitbryon opened this issue Jan 16, 2014 · 3 comments
Open

Document deprecation policy #76

benoitbryon opened this issue Jan 16, 2014 · 3 comments
Labels
feature
Milestone
Later - Medium pr...

Comments

@benoitbryon
Copy link
Collaborator

Tell users about main API at package's root, tests around API...
@benoitbryon
Copy link
Collaborator Author

I tried the following technique:

  • expose main API at package's root.
  • maintain main API, i.e. I test it is not removed/deprecated without DeprecationWarning, whereas I do not care much about moving internals.

Mostly an experiment. But important to mention to users...

@Natim
Copy link
Collaborator

Natim commented Jan 16, 2014

Actually it is an interesting idea.
But I would prefer to distinct package API from test API.
And have test API maintained in django_downloadview.tests and package API maintained in django_downloadview

@benoitbryon
Copy link
Collaborator Author

See https://github.com/benoitbryon/django-downloadview/blob/e33a8165efc7c4aef039fba7155d6f58ccb51a21/django_downloadview/tests/api.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
Later - Medium priority
Development

No branches or pull requests
2 participants
@Natim @benoitbryon