Document deprecation policy

jazzband / django-downloadview

Serve files with Django.

https://django-downloadview.readthedocs.io

Other

380 stars 58 forks source link

Document deprecation policy #76

Open benoitbryon opened 10 years ago

benoitbryon commented 10 years ago

Tell users about main API at package's root, tests around API...

benoitbryon commented 10 years ago

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 commented 10 years ago

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 commented 10 years ago

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