Skip to content
Snippets Groups Projects
Commit 4d18e867 authored by Piotr Maślanka's avatar Piotr Maślanka
Browse files

fix docs

parent 81ac0b33
No related branches found
No related tags found
No related merge requests found
...@@ -45,7 +45,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -45,7 +45,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'alabaster' html_theme = 'alabaster'
master_doc = 'index'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
......
...@@ -4,6 +4,7 @@ Integration with Satella's MemoryPressureManager ...@@ -4,6 +4,7 @@ Integration with Satella's MemoryPressureManager
This library integrates itself with Satella_ MemoryPressureManager_. This library integrates itself with Satella_ MemoryPressureManager_.
.. _Satella: https://github.com/piotrmaslanka/satella .. _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. It will close the non-required chunks when remaining in severity 1 each 30 seconds.
......
...@@ -30,7 +30,13 @@ cdef class Iterator: ...@@ -30,7 +30,13 @@ cdef class Iterator:
cpdef void close(self): 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: if self.closed:
return return
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment