On Tue, Oct 5, 2010 at 2:55 AM, Laurent Luce <laurentluc...@yahoo.com> wrote: > Hello, > > I am looking at ticket #14268 on reset and sqlreset management > commands should raise PendingDeprecationWarning for 1.3. > > I added some code to django/core/management/commands/reset.py and > django/core/management/sql.py to raise the appropriate warning. > > What message should I displayed ? I have the following right now: > "This command is pending deprecation." I know it is not really > insightful. The real reason is that those commands don't work well but > I don't think we want to have that as the message.
Something short and pithy is all you need. There are a couple of existing PendingDeprecationWarnings in Django's code already; use those as a guide for appropriate style. Don't get too concerned about getting the text completely perfect, though; a core committer will probably give the text a polish before they commit. > I guess I also need to update docs/releases/1.3.txt with an > explanation on why deprecation is pending. Correct. Again, don't get too concerned about the exact text -- documentation is almost *always* polished before committing. > Finally, do I need to update the following files with the warning > information. > docs/ref/django-admin.txt > docs/man/django-admin.1 Yes. In ref/django-admin.txt, you can use a Sphinx annotation to declare the deprecated feature: .. deprecated:: 1.3 There are a couple of other uses of this in the docs, so search around for examples of usage. You might also want to do a quick audit of django-admin.1 to check that we actually have all the builtin admin commands... I have a sneaking suspicion there might be a couple missing. Yours, Russ Magee %-) -- You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-develop...@googlegroups.com. To unsubscribe from this group, send email to django-developers+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/django-developers?hl=en.
