From 4c65011ba32a60a1e49200cc2c5ea4bdf0741cc7 Mon Sep 17 00:00:00 2001
From: Tobias Schmidt <tobias.schmidt@unibas.ch>
Date: Tue, 25 Oct 2011 13:05:51 +0200
Subject: [PATCH] added python documentation for chemtype
---
modules/mol/base/doc/entity.rst | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/modules/mol/base/doc/entity.rst b/modules/mol/base/doc/entity.rst
index 85b6abdc9..08008da21 100644
--- a/modules/mol/base/doc/entity.rst
+++ b/modules/mol/base/doc/entity.rst
@@ -511,6 +511,12 @@ The Handle Classes
The chemical class of a residue is used to broadly categorize residues based
on their chemical properties. For example, peptides belong to the
`L_PEPTIDE_LINKING` or `D_PEPTIDE_LINKING` classes.
+
+ .. attribute:: chem_type
+
+ The chemical type of a residue is a classification of all compounds
+ obtained from the PDB component dictionary. For example, ions belong to the
+ class `ChemType::IONS`, amino acids to `ChemType::AMINOACIDS`.
.. attribute:: sec_structure
@@ -559,6 +565,9 @@ The Handle Classes
See :attr:`psi_torsion`
+ .. method:: GetChemType()
+
+ See :attr:`chem_type`
.. class:: AtomHandle
--
GitLab