From 4d18e867e9d66605481ab038de72031060c4cf96 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Mon, 30 Nov 2020 19:56:29 +0100
Subject: [PATCH] fix docs
---
docs/conf.py | 2 +-
docs/memory-pressure-manager.rst | 1 +
tempsdb/iterators.pyx | 8 +++++++-
3 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index c9865de..ed098b5 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -45,7 +45,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# a list of builtin themes.
#
html_theme = 'alabaster'
-
+master_doc = 'index'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
diff --git a/docs/memory-pressure-manager.rst b/docs/memory-pressure-manager.rst
index d150b7a..8f21b1d 100644
--- a/docs/memory-pressure-manager.rst
+++ b/docs/memory-pressure-manager.rst
@@ -4,6 +4,7 @@ Integration with Satella's MemoryPressureManager
This library integrates itself with Satella_ MemoryPressureManager_.
.. _Satella: https://github.com/piotrmaslanka/satella
+.. _MemoryPressureManager: https://satella.readthedocs.io/en/latest/instrumentation/memory.html
It will close the non-required chunks when remaining in severity 1 each 30 seconds.
diff --git a/tempsdb/iterators.pyx b/tempsdb/iterators.pyx
index 3542b94..216874f 100644
--- a/tempsdb/iterators.pyx
+++ b/tempsdb/iterators.pyx
@@ -30,7 +30,13 @@ cdef class Iterator:
cpdef void close(self):
"""
- Close this iterator, release chunks
+ Close this iterator, release chunks.
+
+ It is imperative that you call this, otherwise some chunks might remain in memory.
+
+ This is hooked by destructor, but release it manually ASAP.
+
+ No-op if iterator is already closed.
"""
if self.closed:
return
--
GitLab