From 1b5b6816a4aafc2cda169ae45ab67c494b62e7af Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Thu, 16 Apr 2020 11:54:56 +0200
Subject: [PATCH] doc: make it clear that GetMMCifPDBChainTr needs an entity
read with seqres=True
---
modules/io/doc/mmcif.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/modules/io/doc/mmcif.rst b/modules/io/doc/mmcif.rst
index c53a8b858..f0ad0c778 100644
--- a/modules/io/doc/mmcif.rst
+++ b/modules/io/doc/mmcif.rst
@@ -245,7 +245,9 @@ of the annotation available.
.. method:: GetMMCifPDBChainTr(cif_chain_id)
Get the translation of a certain mmCIF chain name to the traditional PDB
- chain name.
+ chain name. Only works if SEQRES records are read in
+ :func:`~ost.io.LoadMMCIF` and a compound library is available (see
+ :func:`~ost.conop.GetDefaultLib`).
:param cif_chain_id: atom_site.label_asym_id
:type cif_chain_id: :class:`str`
--
GitLab