From c5e11cb1bd6f700fa1ac6bd012bbc3abf862468a Mon Sep 17 00:00:00 2001
From: Stefan Bienert <stefan.bienert@unibas.ch>
Date: Thu, 14 Jun 2012 19:14:17 +0200
Subject: [PATCH] Polished AddResidue documentation.
---
modules/mol/base/doc/entity.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/modules/mol/base/doc/entity.rst b/modules/mol/base/doc/entity.rst
index 258475105..64bc2549a 100644
--- a/modules/mol/base/doc/entity.rst
+++ b/modules/mol/base/doc/entity.rst
@@ -892,11 +892,11 @@ The View Classes
view, it will be added. By default, only the residue is added, but not its
atoms. This behaviour can be modified by passing in an appropriate
combination of `view_add_flags`.
-
- :param residue_handle:
- :type residue_handle: ResidueHandle
- :param view_add_flags:
- :type view_add_flags: int
+
+ :param residue_handle: The residue handle to be added
+ :type residue_handle: :class:`ResidueHandle`
+ :param view_add_flags: An ORed together combination of `view_add_flags`
+ :type view_add_flags: :class:`int`
:rtype: :class:`ResidueView`
.. method:: AddAtom(atom_handle[, view_add_flags])
@@ -1239,10 +1239,10 @@ The View Classes
undefined. By default, only the residue, but no atoms are added to the view.
To change the behavior, pass in a suitable combination of `view_add_flags`.
- :param residue_handle:
+ :param residue_handle: The residue handle to be added.
:type residue_handle: :class:`ResidueHandle`
- :param view_add_flags:
- :type view_add_flags: int
+ :param view_add_flags: An ORed together combination of `view_add_flags`
+ :type view_add_flags: :class:`int`
:rtype: :class:`ResidueView`
.. method:: FindAtom(res_num, atom_name)
--
GitLab