[vlc-commits] python: documentation fixes

[Olivier Aubert]

vlc/python | branch: master | Olivier Aubert <contact at olivieraubert.net> | Sun Mar 31 20:15:17 2019 +0200| [8603374d4a2591a83dbc43f2c23f6fdeb02ce2c6] | committer: Olivier Aubert

python: documentation fixes

> http://git.videolan.org/gitweb.cgi/vlc/python.git/?a=commit;h=8603374d4a2591a83dbc43f2c23f6fdeb02ce2c6
---

 generator/templates/header.py   | 6 +++---
 generator/templates/override.py | 5 ++++-
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/generator/templates/header.py b/generator/templates/header.py
index f0d03c2..1aef0ae 100755
--- a/generator/templates/header.py
+++ b/generator/templates/header.py
@@ -28,7 +28,7 @@
 U{http://wiki.videolan.org/LibVLC}.
 
 You can find the documentation and a README file with some examples
-at U{http://www.olivieraubert.net/vlc/python-ctypes/}.
+at U{https://www.olivieraubert.net/vlc/python-ctypes/}.
 
 Basically, the most important class is L{Instance}, which is used
 to create a libvlc instance.  From this instance, you then create
@@ -295,7 +295,7 @@ def _Constructor(cls, ptr=_internal_guard):
 class _Cstruct(ctypes.Structure):
     """(INTERNAL) Base class for ctypes structures.
     """
-    _fields_ = []  # list of 2-tuples ('name', ctyptes.<type>)
+    _fields_ = []  # list of 2-tuples ('name', ctypes.<type>)
 
     def __str__(self):
         l = [' %s:\t%s' % (n, getattr(self, n)) for n, _ in self._fields_]
@@ -316,7 +316,7 @@ class _Ctype(object):
         return this._as_parameter_
 
 class ListPOINTER(object):
-    """Just like a POINTER but accept a list of ctype as an argument.
+    """Just like a POINTER but accept a list of etype elements as an argument.
     """
     def __init__(self, etype):
         self.etype = etype
diff --git a/generator/templates/override.py b/generator/templates/override.py
index 0207386..309fce0 100644
--- a/generator/templates/override.py
+++ b/generator/templates/override.py
@@ -448,7 +448,10 @@ class EventManager:
 
         @note: The callback function must have at least one argument,
         an Event instance.  Any other, optional positional and keyword
-        arguments are in B{addition} to the first one.
+        arguments are in B{addition} to the first one. Warning: libvlc
+        is not reentrant, i.e. you cannot call libvlc functions from
+        an event handler. They must be called from the main
+        application thread.
         """
         if not isinstance(eventtype, EventType):
             raise VLCException("%s required: %r" % ('EventType', eventtype))