From 5ee7d1d25859576d5500dc31d44aaa8d49ba2fc9 Mon Sep 17 00:00:00 2001 From: Xavier Robin <xavier.robin@unibas.ch> Date: Thu, 26 Jan 2023 14:52:07 +0100 Subject: [PATCH] doc: consistently have .handle as first attribute in Views --- modules/mol/base/doc/entity.rst | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/modules/mol/base/doc/entity.rst b/modules/mol/base/doc/entity.rst index 5df0433cf..0bbf46aa1 100644 --- a/modules/mol/base/doc/entity.rst +++ b/modules/mol/base/doc/entity.rst @@ -1264,6 +1264,13 @@ The View Classes An entity view represents a structural subset of an :class:`EntityHandle`. For an introduction ,see :doc:`../../intro-01`. + + .. attribute:: handle + + The underlying :class:`handle <EntityHandle>` of the entity view. Also + available as :meth:`GetHandle`. + + :type: :class:`EntityHandle` .. attribute:: chains @@ -1329,13 +1336,6 @@ The View Classes :type: :class:`ost.geom.AlignedCuboid` - .. attribute:: handle - - The underlying :class:`handle <EntityHandle>` of the entity view. Also - available as :meth:`GetHandle`. - - :type: :class:`EntityHandle` - .. attribute:: valid Validity of view. @@ -1615,6 +1615,12 @@ The View Classes A view representation of a :class:`ChainHandle`. Mostly, the same functionality is provided as for the handle. + .. attribute:: handle + + The chain handle this view points to. Also available as :meth:`GetHandle`. + + :type: :class:`ChainHandle` + .. attribute:: name The chain name. The name uniquely identifies the chain in the entity. In @@ -1668,7 +1674,6 @@ The View Classes :type: bool - .. attribute:: atoms Get list of all atoms of this chain. To access a single atom, use @@ -1703,12 +1708,6 @@ The View Classes :type: :class:`~ost.geom.Vec3` - .. attribute:: handle - - The chain handle this view points to. Also available as :meth:`GetHandle`. - - :type: :class:`ChainHandle` - .. attribute:: geometric_center Mid-point of the axis aligned bounding box of the entity. -- GitLab