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

doc: correct argument names

parent ba9b467e
No related branches found
No related tags found
No related merge requests found
...@@ -204,7 +204,7 @@ The basic functionality of editors is implemented in the EditorBase class. ...@@ -204,7 +204,7 @@ The basic functionality of editors is implemented in the EditorBase class.
:type is_hetatm: bool :type is_hetatm: bool
:returns: :class:`AtomHandle` :returns: :class:`AtomHandle`
.. method:: InsertAltAtom(residue, atom_name, alt_group, pos, element="", occupancy=1.0, b_factor=0.0) .. method:: InsertAltAtom(residue, atom_name, alt_group, pos, ele="", occ=1.0, b_factor=0.0)
Insert new atom with alternative position indicator Insert new atom with alternative position indicator
...@@ -221,14 +221,14 @@ The basic functionality of editors is implemented in the EditorBase class. ...@@ -221,14 +221,14 @@ The basic functionality of editors is implemented in the EditorBase class.
:type alt_group: string :type alt_group: string
:param pos: is the position of the atom in global coordinates :param pos: is the position of the atom in global coordinates
:type pos: :class:`~ost.geom.Vec3` :type pos: :class:`~ost.geom.Vec3`
:param element: is the atom's element. If set to a a valid element, :param ele: is the atom's element. If set to a a valid element,
atom properties such as mass, charge, radius are set atom properties such as mass, charge, radius are set
based on default values for that element. If the element based on default values for that element. If the element
string is empty, or unknown, the properties are filled string is empty, or unknown, the properties are filled
with rather meaningless default values. with rather meaningless default values.
:type element: class:`string` :type ele: class:`string`
:param occupancy: The occupancy of the atom. between 0 and 1 :param occ: The occupancy of the atom. between 0 and 1
:type occupancy: float :type occ: float
:param b_factor: temperature factor. :param b_factor: temperature factor.
:type b_factor: float :type b_factor: float
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment