From 18dcd74986b1398ba68380c0fce19cf35783b169 Mon Sep 17 00:00:00 2001
From: Rafal Gumienny <r.gumienny@unibas.ch>
Date: Thu, 26 Apr 2018 15:50:43 +0200
Subject: [PATCH] docs: SCHWED-3121 Update ReadStereoChemicalPropsFile
 documentation

---
 modules/io/doc/io.rst | 40 +++++++++++++---------------------------
 1 file changed, 13 insertions(+), 27 deletions(-)

diff --git a/modules/io/doc/io.rst b/modules/io/doc/io.rst
index aa3e15991..0f5c04dd4 100644
--- a/modules/io/doc/io.rst
+++ b/modules/io/doc/io.rst
@@ -351,37 +351,23 @@ before computing the lDDT scores it is required to pass parameter file based on
 Engh and Huber parameters, and on the atomic radii as defined in the Cambridge
 Structural Database. OpenStructure ships with default file called
 `stereo_chemical_props.txt` located in `$OST_ROOT/share/openstructure`
-directory. A class :class:`~ost.io.StereoChemicalParamsReader` is used to read
-this file.
+directory. A function :function:`~ost.io.ReadStereoChemicalPropsFile` is used to
+read this file.
 
-.. class:: StereoChemicalParamsReader(filename="")
 
-  Object that holds and reads stereochemical parameters.
 
-  :param filename: Sets :attr:`filename`.
+.. function:: ReadStereoChemicalPropsFile(filename="", check=True)
 
-  .. attribute:: bond_table
+  Read stereochemical parameters - if not provided a local version will be used.
 
-    The table containing bond information of type :class:`~ost.mol.alg.StereoChemicalParams`.
+  :param filename: The path to the parameter file that will be used. If set
+                   to "", it reads the default file shipped with OpenStructure.
+  :type filename: :class:`str`
+  :param check: Raise an error when any of the resulting tables are empty.
+  :type check:  :class:`bool`
+  :return: Object containing stereochemical parameters
+  :rtype: :class:`~ost.mol.alg.StereoChemicalProps`
 
-  .. attribute:: angle_table
+.. function:: GetStereoChemicalPropsFile()
 
-    The table containing angle information of type :class:`~ost.mol.alg.StereoChemicalParams`.
-
-  .. attribute:: nonbonded_table
-
-    The table containing clashes of type :class:`~ost.mol.alg.ClashingDistances`.
-
-  .. attribute:: filename
-
-    The path to the parameter file that will be used. If set to "", it reads the
-    default file shipped with OpenStructure.
-
-    :type: :class:`str`
-
-  .. method:: Read(check=False)
-
-    Read the file.
-
-    :param check: Raise an error when any of the resulting tables are empty.
-    :type check:  :class:`bool`
+  Get the default path to the stereochemical paramteres file.
-- 
GitLab