Skip to content

Commit b630891

Browse files
committed
more docs
1 parent 5c260d4 commit b630891

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/scanpy/_settings.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,17 @@ def level(self) -> int:
106106
def override(
107107
self, verbosity: Verbosity | _VerbosityName | int
108108
) -> Generator[Verbosity, None, None]:
109-
"""Temporarily override verbosity."""
109+
"""Temporarily override verbosity.
110+
111+
>>> import scanpy as sc
112+
>>> sc.settings.verbosity
113+
<Verbosity.hint: 3>
114+
>>> with sc.settings.verbosity.override(settings.verbosity.debug):
115+
... sc.settings.verbosity
116+
<Verbosity.debug: 4>
117+
>>> sc.settings.verbosity
118+
<Verbosity.hint: 3>
119+
"""
110120
settings.verbosity = verbosity
111121
yield self
112122
settings.verbosity = self

0 commit comments

Comments
 (0)