From a44d5a341a9451d6f964e33967b9811a2db84d48 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Sat, 6 Dec 2014 16:29:12 -0500 Subject: [PATCH] Python: document FieldDeclaration MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- bindings/python/bt.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/bindings/python/bt.py b/bindings/python/bt.py index 4106b0de..e79a61bb 100644 --- a/bindings/python/bt.py +++ b/bindings/python/bt.py @@ -880,7 +880,11 @@ class EventDeclaration: class FieldDeclaration: - """Field declaration class. Do not instantiate.""" + """ + Base class for concrete field declarations. + + This class is not meant to be instantiated by the user. + """ def __init__(self): raise NotImplementedError("FieldDeclaration cannot be instantiated") @@ -892,15 +896,16 @@ class FieldDeclaration: @property def name(self): - """Return the name of a FieldDeclaration or None on error.""" + """ + Field's name, or ``None`` on error. + """ return self._name @property def type(self): """ - Return the FieldDeclaration's type. One of the entries in class - CTFTypeId. + Field's type (one of :class:`CTFTypeId` constants). """ return nbt._bt_ctf_field_type(self._fd) @@ -908,7 +913,7 @@ class FieldDeclaration: @property def scope(self): """ - Return the FieldDeclaration's scope. + Field's scope (one of :class:`CTFScope` constants). """ return self._s -- 2.34.1