Skip to content

Commit 4eae43b

Browse files
committed
Pull a few straglers into the docs
1 parent baf807d commit 4eae43b

3 files changed

Lines changed: 25 additions & 0 deletions

File tree

av/logging.pyx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,19 @@ level_map = {
3434

3535

3636
def get_level():
37+
"""Return current logging threshold."""
3738
return lib.av_log_get_level()
3839

3940
def set_level(int level):
41+
"""set_level(level)
42+
43+
Set logging threshold."""
4044
lib.av_log_set_level(level)
4145

4246
cdef bint log_after_shutdown = False
4347

4448
def set_log_after_shutdown(v):
49+
"""Set if logging should continue after Python shutdown."""
4550
global log_after_shutdown
4651
log_after_shutdown = v
4752

av/utils.pyx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ cdef int AV_ERROR_MAX_STRING_SIZE = 64
1414

1515

1616
class AVError(EnvironmentError):
17+
"""Exception class for errors from within the underlying FFmpeg/Libav."""
1718
pass
1819
AVError.__module__ = 'av'
1920

docs/api.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,3 +189,22 @@ Subtitles
189189
.. autoclass:: AssSubtitle
190190
:members:
191191

192+
193+
Utilities
194+
=========
195+
196+
Logging
197+
-------
198+
199+
.. automodule:: av.logging
200+
:members:
201+
202+
Other
203+
-----
204+
205+
.. automodule:: av.utils
206+
:members:
207+
208+
.. autoclass:: AVError
209+
210+

0 commit comments

Comments
 (0)