From 788586f87142c4540b39423a2a91743c21314159 Mon Sep 17 00:00:00 2001 From: martin bendsoe Date: Fri, 5 Jun 2020 15:38:36 +0200 Subject: [PATCH] added breaking change to api documentation. --- docs/source/breaking_changes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/breaking_changes.rst b/docs/source/breaking_changes.rst index 41a021123..fe7ef6cc0 100644 --- a/docs/source/breaking_changes.rst +++ b/docs/source/breaking_changes.rst @@ -85,6 +85,8 @@ API Changes * :code:`Result.summary()` has been replaced with :code:`Result.consume()`, this behaviour is to consume all remaining records in the buffer and returns the ResultSummary. +* :code:`Result.data()` has been removed. Use :code:`Record.data()` for each Record when iterating the Result object. + * :code:`Transaction.sync()` has been removed. Use :code:`Result.consume()` if the behaviour is to exhaust the result object. * :code:`Transaction.success` has been removed.