From cac56d836ddaa4a592c7699b6f4e434de43af7b9 Mon Sep 17 00:00:00 2001
From: Gerardo Tauriello <gerardo.tauriello@unibas.ch>
Date: Wed, 12 Apr 2017 19:04:44 +0200
Subject: [PATCH] Doc update - naming of entities.
---
modules/mol/base/doc/entity.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/modules/mol/base/doc/entity.rst b/modules/mol/base/doc/entity.rst
index f55380bb1..6d96c6b7b 100644
--- a/modules/mol/base/doc/entity.rst
+++ b/modules/mol/base/doc/entity.rst
@@ -91,6 +91,16 @@ The Handle Classes
:type: :class:`~ost.geom.Vec3`
+ .. method:: GetName()
+
+ :returns: Name associated to this entity.
+ :rtype: :class:`str`
+
+ .. method:: SetName(name)
+
+ :param name: Sets this as new name to be associated to this entity.
+ :type name: :class:`str`
+
.. method:: FindChain(chain_name)
Get chain by name. See also :attr:`chains`
@@ -878,6 +888,16 @@ The View Classes
:type: :class:`EntityHandle`
+ .. method:: GetName()
+
+ :returns: :func:`~EntityHandle.GetName` of entity :attr:`handle`.
+ :rtype: :class:`str`
+
+ .. method:: SetName(name)
+
+ :param name: Passed to :func:`~EntityHandle.SetName` of :attr:`handle`.
+ :type name: :class:`str`
+
.. method:: CreateEmptyView()
See :meth:`EntityHandle.CreateEmptyView`
--
GitLab