Skip to content
Snippets Groups Projects
Unverified Commit fad45b23 authored by Xavier Robin's avatar Xavier Robin
Browse files

doc: SCHWED-5783 document deep on AppendResidue

parent 62472a4f
Branches
Tags
No related merge requests found
...@@ -69,15 +69,21 @@ The basic functionality of editors is implemented in the EditorBase class. ...@@ -69,15 +69,21 @@ The basic functionality of editors is implemented in the EditorBase class.
:returns: :class:`ChainHandle` :returns: :class:`ChainHandle`
.. method:: AppendResidue(chain, residue_name, [res_num]) .. 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 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 residue number will be set to the residue number of the last added residue
plus one. The insertion code is the same. 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 :param chain: Must be a valid chain
:type chain: :class:`ChainHandle` :type chain: :class:`ChainHandle`
:param residue_name: 3-letter-code of the residue, e.g. ``GLY``. :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` :returns: :class:`ResidueHandle`
.. method:: RenameResidue(residue, new_name) .. method:: RenameResidue(residue, new_name)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment