From ed34c2ca68a8005c1c48ef067163e63e273087c2 Mon Sep 17 00:00:00 2001 From: Stefan Wojcik Date: Thu, 9 Feb 2017 12:13:56 -0800 Subject: [PATCH] update the changelog and upgrade docs --- docs/changelog.rst | 2 ++ docs/upgrade.rst | 14 ++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index a38378c8..cd99b73e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,6 +5,8 @@ Changelog Development =========== - (Fill this out as you fix issues and develop you features). +- POTENTIAL BREAKING CHANGE: Fixed limit/skip/hint/batch_size chaining #1476 +- POTENTIAL BREAKING CHANGE: Changed a public `QuerySet.clone_into` method to a private `QuerySet._clone_into` #1476 - Fixed connecting to a replica set with PyMongo 2.x #1436 - Fixed an obscure error message when filtering by `field__in=non_iterable`. #1237 diff --git a/docs/upgrade.rst b/docs/upgrade.rst index c0ae7205..17b1c4ac 100644 --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -2,6 +2,20 @@ Upgrading ######### +Development +*********** +(Fill this out whenever you introduce breaking changes to MongoEngine) + +This release includes various fixes for the `BaseQuerySet` methods and how they +are chained together. Since version 0.10.1 applying limit/skip/hint/batch_size +to an already-existing queryset wouldn't modify the underlying PyMongo cursor. +This has been fixed now, so you'll need to make sure that your code didn't rely +on the broken implementation. + +Additionally, a public `BaseQuerySet.clone_into` has been renamed to a private +`_clone_into`. If you directly used that method in your code, you'll need to +rename its occurrences. + 0.11.0 ****** This release includes a major rehaul of MongoEngine's code quality and