From fad45b2312b6e29deae043e9d84fa5fcba3136db Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavalias-github@xavier.robin.name>
Date: Tue, 24 Jan 2023 17:31:02 +0100
Subject: [PATCH] doc: SCHWED-5783 document deep on AppendResidue
---
modules/mol/base/doc/editors.rst | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/modules/mol/base/doc/editors.rst b/modules/mol/base/doc/editors.rst
index 6205ba44b..1c689de4d 100644
--- a/modules/mol/base/doc/editors.rst
+++ b/modules/mol/base/doc/editors.rst
@@ -69,15 +69,21 @@ The basic functionality of editors is implemented in the EditorBase class.
:returns: :class:`ChainHandle`
.. method:: AppendResidue(chain, residue_name, [res_num])
+ AppendResidue(chain, residue_name, deep=False)
Append residue to the end of the chain. If res_num is not given, the
residue number will be set to the residue number of the last added residue
plus one. The insertion code is the same.
+ By default, atoms and bonds are not added. If deep is `True`, atoms (but
+ not bonds) are added to the new residue, including alternative atoms.
+
:param chain: Must be a valid chain
:type chain: :class:`ChainHandle`
:param residue_name: 3-letter-code of the residue, e.g. ``GLY``.
- :type residue_name: string
+ :type residue_name: :class:`string`
+ :param deep: If set to true, insert atoms as well.
+ :type deep: :class:`bool`
:returns: :class:`ResidueHandle`
.. method:: RenameResidue(residue, new_name)
--
GitLab