diff --git a/docs/conf.py b/docs/conf.py index c9865de954540efdce3caa24e521fe9ebcc3ba02..ed098b54bd0299a63ff73cb023719d54a0d89263 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 d150b7ad475e922b6aa7b4a52c47b41ae0b7b474..8f21b1d0cf61755bf5d7aa77e204fee76daef9d2 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 3542b9406abe873bc591c7064ceab1d111231b72..216874fc94ead134c8b8d24a0eb666c3a66bed9b 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