From b97f1c278adeeda6f30c3ddf5411a49938dac4e7 Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Thu, 26 Jan 2023 13:42:02 +0100
Subject: [PATCH] doc: qualified_name on residues
---
modules/mol/base/doc/entity.rst | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/modules/mol/base/doc/entity.rst b/modules/mol/base/doc/entity.rst
index 26eccc947..a40fdbfdf 100644
--- a/modules/mol/base/doc/entity.rst
+++ b/modules/mol/base/doc/entity.rst
@@ -570,6 +570,16 @@ The Handle Classes
This property is read-only. To change the name of the residue, use
:meth:`~EditorBase.RenameResidue`.
+
+ :type: str
+
+ .. attribute:: qualified_name
+
+ The qualified name consists of a residue identifier and chain name.
+ For a glycine with residue number 2 of chain A, the qualified name is
+ "A.GLY2". Also available as :meth:`GetQualifiedName`.
+
+ :type: str
.. attribute:: number
@@ -804,6 +814,10 @@ The Handle Classes
:returns: Whether the switch was successful (e.g. False if no such
group exists)
+ .. method:: GetQualifiedName()
+
+ See :attr:`qualified_name`
+
.. method:: GetAtomList()
See :attr:`atoms`
@@ -1804,6 +1818,11 @@ The View Classes
This property is read-only. To change the name of the residue, use
:meth:`~EditorBase.RenameResidue`.
+ .. attribute:: qualified_name
+
+ See :meth:`~ResidueHandle.qualified_name`.
+ Also available as :meth:`GetQualifiedName`.
+
.. attribute:: number
The number of this residue. The residue number has a numeric part and an
@@ -1893,6 +1912,10 @@ The View Classes
See :attr:`handle`
+ .. method:: GetQualifiedName()
+
+ See :attr:`qualified_name`
+
.. method:: GetMass()
See :attr:`mass`
--
GitLab