From d940b696baaf049d86df107053d49dbebf1042a6 Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Wed, 3 Apr 2019 18:02:24 +0200
Subject: [PATCH] Document io.mmcif.MMCifInfo.(G|S)etObsoleteInfo()
---
modules/io/doc/mmcif.rst | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/modules/io/doc/mmcif.rst b/modules/io/doc/mmcif.rst
index 479085543..fd7b214fb 100644
--- a/modules/io/doc/mmcif.rst
+++ b/modules/io/doc/mmcif.rst
@@ -150,6 +150,15 @@ of the annotation available.
:type: :class:`MMCifInfoRevisions`
+ .. attribute:: obsolete
+
+ Stores information about obsoleted / superseded entries.
+
+ Also available as :meth:`GetObsoleteInfo`. May also be modified by
+ :meth:`SetObsoleteInfo`.
+
+ :type: :class:`MMCifInfoObsolete`
+
.. method:: AddCitation(citation)
Add a citation to the citation list of an info object.
@@ -286,6 +295,14 @@ of the annotation available.
Set the date, when this entry first entered the PDB. Ignored if it was set
in the past. See :meth:`MMCifInfoRevisions.SetDateOriginal`.
+ .. method:: GetObsoleteInfo()
+
+ See :attr:`obsolete`
+
+ .. method:: SetObsoleteInfo()
+
+ See :attr:`obsolete`
+
.. class:: MMCifInfoCitation
This stores citation information from an input file.
@@ -894,7 +911,8 @@ of the annotation available.
.. class:: MMCifInfoObsolete
- Holds details on obsolete/ superseded structures.
+ Holds details on obsolete / superseded structures. The data is
+ available both in the obsolete and in the replacement entries.
.. attribute:: date
--
GitLab