Procházet zdrojové kódy

Deprecated django.contrib.comments.

Jacob Kaplan-Moss před 12 roky
rodič
revize
571b2d139b

+ 3 - 0
django/contrib/comments/__init__.py

@@ -1,3 +1,4 @@
+import warnings
 from django.conf import settings
 from django.core import urlresolvers
 from django.core.exceptions import ImproperlyConfigured
@@ -5,6 +6,8 @@ from django.contrib.comments.models import Comment
 from django.contrib.comments.forms import CommentForm
 from django.utils.importlib import import_module
 
+warnings.warn("django.contrib.comments is deprecated and will be removed before Django 1.8.", PendingDeprecationWarning)
+
 DEFAULT_COMMENTS_APP = 'django.contrib.comments'
 
 def get_comment_app():

+ 0 - 1
docs/index.txt

@@ -254,7 +254,6 @@ applications:
 * :doc:`Logging <topics/logging>`
 * :doc:`Sending emails <topics/email>`
 * :doc:`Syndication feeds (RSS/Atom) <ref/contrib/syndication>`
-* :doc:`Comments <ref/contrib/comments/index>`, :doc:`comment moderation <ref/contrib/comments/moderation>` and :doc:`custom comments <ref/contrib/comments/custom>`
 * :doc:`Pagination <topics/pagination>`
 * :doc:`Messages framework <ref/contrib/messages>`
 * :doc:`Serialization <topics/serialization>`

+ 2 - 0
docs/internals/deprecation.txt

@@ -365,6 +365,8 @@ these changes.
   - ``django.db.transaction.commit_unless_managed()``
   - ``django.db.transaction.rollback_unless_managed()``
 
+* ``django.contrib.comments`` will be removed.
+
 2.0
 ---
 

+ 12 - 0
docs/ref/contrib/comments/custom.txt

@@ -4,6 +4,18 @@ Customizing the comments framework
 
 .. currentmodule:: django.contrib.comments
 
+.. warning::
+
+    Django's comment framework has been deprecated and is no longer supported.
+    Most users will be better served with a custom solution, or a hosted
+    product like Disqus__.
+
+    The code formerly known as ``django.contrib.comments`` is `still available
+    in an external repository`__.
+
+    __ https://disqus.com/
+    __ https://github.com/django/django-contrib-comments
+
 If the built-in comment framework doesn't quite fit your needs, you can extend
 the comment app's behavior to add custom data and logic. The comments framework
 lets you extend the built-in comment model, the built-in comment form, and the

+ 12 - 0
docs/ref/contrib/comments/example.txt

@@ -4,6 +4,18 @@
 Example of using the built-in comments app
 ===========================================
 
+.. warning::
+
+    Django's comment framework has been deprecated and is no longer supported.
+    Most users will be better served with a custom solution, or a hosted
+    product like Disqus__.
+
+    The code formerly known as ``django.contrib.comments`` is `still available
+    in an external repository`__.
+
+    __ https://disqus.com/
+    __ https://github.com/django/django-contrib-comments
+
 Follow the first three steps of the quick start guide in the
 :doc:`documentation </ref/contrib/comments/index>`.
 

+ 13 - 1
docs/ref/contrib/comments/forms.txt

@@ -5,6 +5,18 @@ Comment form classes
 .. module:: django.contrib.comments.forms
    :synopsis: Forms for dealing with the built-in comment model.
 
+.. warning::
+
+    Django's comment framework has been deprecated and is no longer supported.
+    Most users will be better served with a custom solution, or a hosted
+    product like Disqus__.
+
+    The code formerly known as ``django.contrib.comments`` is `still available
+    in an external repository`__.
+
+    __ https://disqus.com/
+    __ https://github.com/django/django-contrib-comments
+
 The ``django.contrib.comments.forms`` module contains a handful of forms
 you'll use when writing custom views dealing with comments, or when writing
 :doc:`custom comment apps </ref/contrib/comments/custom>`.
@@ -43,4 +55,4 @@ forms that you can subclass to reuse pieces of the form handling logic:
    Handles the details of the comment itself.
 
    This class contains the ``name``, ``email``, ``url``, and the ``comment``
-   field itself, along with the associated validation logic.
+   field itself, along with the associated validation logic.

+ 12 - 0
docs/ref/contrib/comments/index.txt

@@ -7,6 +7,18 @@ Django's comments framework
 
 .. highlightlang:: html+django
 
+.. warning::
+
+    Django's comment framework has been deprecated and is no longer supported.
+    Most users will be better served with a custom solution, or a hosted
+    product like Disqus__.
+
+    The code formerly known as ``django.contrib.comments`` is `still available
+    in an external repository`__.
+
+    __ https://disqus.com/
+    __ https://github.com/django/django-contrib-comments
+
 Django includes a simple, yet customizable comments framework. The built-in
 comments framework can be used to attach comments to any model, so you can use
 it for comments on blog entries, photos, book chapters, or anything else.

+ 12 - 0
docs/ref/contrib/comments/models.txt

@@ -5,6 +5,18 @@ The built-in comment models
 .. module:: django.contrib.comments.models
    :synopsis: The built-in comment models
 
+.. warning::
+
+    Django's comment framework has been deprecated and is no longer supported.
+    Most users will be better served with a custom solution, or a hosted
+    product like Disqus__.
+
+    The code formerly known as ``django.contrib.comments`` is `still available
+    in an external repository`__.
+
+    __ https://disqus.com/
+    __ https://github.com/django/django-contrib-comments
+
 .. class:: Comment
 
     Django's built-in comment model. Has the following fields:

+ 12 - 0
docs/ref/contrib/comments/moderation.txt

@@ -5,6 +5,18 @@ Generic comment moderation
 .. module:: django.contrib.comments.moderation
    :synopsis: Support for automatic comment moderation.
 
+.. warning::
+
+    Django's comment framework has been deprecated and is no longer supported.
+    Most users will be better served with a custom solution, or a hosted
+    product like Disqus__.
+
+    The code formerly known as ``django.contrib.comments`` is `still available
+    in an external repository`__.
+
+    __ https://disqus.com/
+    __ https://github.com/django/django-contrib-comments
+
 Django's bundled comments application is extremely useful on its own,
 but the amount of comment spam circulating on the Web today
 essentially makes it necessary to have some sort of automatic

+ 12 - 0
docs/ref/contrib/comments/signals.txt

@@ -5,6 +5,18 @@ Signals sent by the comments app
 .. module:: django.contrib.comments.signals
    :synopsis: Signals sent by the comment module.
 
+.. warning::
+
+    Django's comment framework has been deprecated and is no longer supported.
+    Most users will be better served with a custom solution, or a hosted
+    product like Disqus__.
+
+    The code formerly known as ``django.contrib.comments`` is `still available
+    in an external repository`__.
+
+    __ https://disqus.com/
+    __ https://github.com/django/django-contrib-comments
+
 The comment app sends a series of :doc:`signals </topics/signals>` to allow for
 comment moderation and similar activities. See :doc:`the introduction to signals
 </topics/signals>` for information about how to register for and receive these

+ 13 - 0
docs/releases/1.6.txt

@@ -271,6 +271,19 @@ current APIs are deprecated:
 The reasons for this change and the upgrade path are described in the
 :ref:`transactions documentation <transactions-upgrading-from-1.5>`.
 
+``django.contrib.comments``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Django's comment framework has been deprecated and is no longer supported. It
+will be available in Django 1.6 and 1.7, and removed in Django 1.8. Most users
+will be better served with a custom solution, or a hosted product like Disqus__.
+
+The code formerly known as ``django.contrib.comments`` is `still available
+in an external repository`__.
+
+__ https://disqus.com/
+__ https://github.com/django/django-contrib-comments
+
 Changes to :ttag:`cycle` and :ttag:`firstof`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~