From dad5effe7b79d86f8c39444cc0c2b93ac9ed33ec Mon Sep 17 00:00:00 2001 From: Blake Eggleston Date: Wed, 19 Jun 2013 09:55:54 -0700 Subject: [PATCH] adding change warning to all doc pages --- docs/index.rst | 4 ++++ docs/topics/columns.rst | 4 ++++ docs/topics/connection.rst | 4 ++++ docs/topics/manage_schemas.rst | 6 ++++++ docs/topics/models.rst | 6 ++++++ docs/topics/queryset.rst | 6 ++++++ 6 files changed, 30 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 2901f2af..9dff72fd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,10 @@ cqlengine documentation ======================= +**Users of versions < 0.4, please read this post before upgrading:** `Breaking Changes`_ + +.. _Breaking Changes: https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU + cqlengine is a Cassandra CQL 3 Object Mapper for Python with an interface similar to the Django orm and mongoengine :ref:`getting-started` diff --git a/docs/topics/columns.rst b/docs/topics/columns.rst index 61252e7f..987d7d7c 100644 --- a/docs/topics/columns.rst +++ b/docs/topics/columns.rst @@ -2,6 +2,10 @@ Columns ======= +**Users of versions < 0.4, please read this post before upgrading:** `Breaking Changes`_ + +.. _Breaking Changes: https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU + .. module:: cqlengine.columns .. class:: Bytes() diff --git a/docs/topics/connection.rst b/docs/topics/connection.rst index 48558f9c..88f601fb 100644 --- a/docs/topics/connection.rst +++ b/docs/topics/connection.rst @@ -2,6 +2,10 @@ Connection ============== +**Users of versions < 0.4, please read this post before upgrading:** `Breaking Changes`_ + +.. _Breaking Changes: https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU + .. module:: cqlengine.connection The setup function in `cqlengine.connection` records the Cassandra servers to connect to. diff --git a/docs/topics/manage_schemas.rst b/docs/topics/manage_schemas.rst index 2174e56f..413b53c4 100644 --- a/docs/topics/manage_schemas.rst +++ b/docs/topics/manage_schemas.rst @@ -2,6 +2,12 @@ Managing Schmas =============== +**Users of versions < 0.4, please read this post before upgrading:** `Breaking Changes`_ + +.. _Breaking Changes: https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU + +.. module:: cqlengine.connection + .. module:: cqlengine.management Once a connection has been made to Cassandra, you can use the functions in ``cqlengine.management`` to create and delete keyspaces, as well as create and delete tables for defined models diff --git a/docs/topics/models.rst b/docs/topics/models.rst index 5dc322f6..f599f2cf 100644 --- a/docs/topics/models.rst +++ b/docs/topics/models.rst @@ -2,6 +2,12 @@ Models ====== +**Users of versions < 0.4, please read this post before upgrading:** `Breaking Changes`_ + +.. _Breaking Changes: https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU + +.. module:: cqlengine.connection + .. module:: cqlengine.models A model is a python class representing a CQL table. diff --git a/docs/topics/queryset.rst b/docs/topics/queryset.rst index c237ed6b..0a481fbe 100644 --- a/docs/topics/queryset.rst +++ b/docs/topics/queryset.rst @@ -2,6 +2,12 @@ Making Queries ============== +**Users of versions < 0.4, please read this post before upgrading:** `Breaking Changes`_ + +.. _Breaking Changes: https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU + +.. module:: cqlengine.connection + .. module:: cqlengine.query Retrieving objects