Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
openstructure
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container Registry
Model registry
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
schwede
openstructure
Commits
5df9cf1a
Unverified
Commit
5df9cf1a
authored
1 year ago
by
Xavier Robin
Browse files
Options
Downloads
Patches
Plain Diff
doc: clarify AppendResidue can take a residue handle
parent
2427d5b2
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
modules/mol/base/doc/editors.rst
+11
-6
11 additions, 6 deletions
modules/mol/base/doc/editors.rst
with
11 additions
and
6 deletions
modules/mol/base/doc/editors.rst
+
11
−
6
View file @
5df9cf1a
...
...
@@ -69,19 +69,24 @@ 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)
AppendResidue(chain, residue, 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.
Append residue to the end of the chain.
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.
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.
It is possible to give a residue handle as second argument, instead of a
residue name. 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: :class:`string`
:param residue: A residue handle to copy
:type residue: :class:`ResidueHandle`
:param deep: If set to true, insert atoms as well.
:type deep: :class:`bool`
:returns: :class:`ResidueHandle`
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment