From 0e5e3388bac5f27b7f1e38b32a205e30970ccaf1 Mon Sep 17 00:00:00 2001
From: Gabriel Studer <gabriel.studer@unibas.ch>
Date: Mon, 22 Jan 2024 09:06:39 +0100
Subject: [PATCH] mmcif writer: docu update
---
modules/io/doc/mmcif.rst | 2 ++
modules/io/pymod/__init__.py | 2 +-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/modules/io/doc/mmcif.rst b/modules/io/doc/mmcif.rst
index b05225f2e..340d16c98 100644
--- a/modules/io/doc/mmcif.rst
+++ b/modules/io/doc/mmcif.rst
@@ -1594,6 +1594,8 @@ The content of the written file:
:type filename: :class:`str`
+.. _MMCif writing:
+
mmCIF Writer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/modules/io/pymod/__init__.py b/modules/io/pymod/__init__.py
index 73ac9e656..caec78dae 100644
--- a/modules/io/pymod/__init__.py
+++ b/modules/io/pymod/__init__.py
@@ -468,7 +468,7 @@ def SaveMMCIF(ent, filename, data_name="OST_structure", mmcif_conform = True):
identifier.
:param mmcif_conform: Controls processing of structure, i.e. identification
of mmCIF entities etc. before writing. Detailed
- description is in the documentation below. In short:
+ description in :ref:`MMCif writing`. In short:
If *mmcif_conform* is set to True, Chains in *ent* are
expected to be valid mmCIF entities with residue numbers
set according to underlying SEQRES. That should be the
--
GitLab