From c1d67e3092f055aa918f18e33dc33e7ce293fb5c Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Fri, 11 Dec 2020 15:31:03 +0100
Subject: [PATCH] Clarify to use XCSEditor to access EditorBase functions
---
modules/mol/base/doc/editors.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/modules/mol/base/doc/editors.rst b/modules/mol/base/doc/editors.rst
index cc3846a71..fcb6c3026 100644
--- a/modules/mol/base/doc/editors.rst
+++ b/modules/mol/base/doc/editors.rst
@@ -41,6 +41,12 @@ Basic Editing Operations
The basic functionality of editors is implemented in the EditorBase class.
+.. note::
+
+ To use the editing functions available in :class:`EditorBase`, it is
+ recommended to use the external coordinate system :class:`XCSEditor` for
+ performance reasons.
+
.. class:: EditorBase
Inherited by :class:`XCSEditor`, :class:`ICSEditor`.
@@ -486,6 +492,13 @@ using an :class:`ICSEditor` is undefined and vice versa.
a directed-graph for the bond network as well as calculating the internal
coordinate matrices.
+.. warning::
+
+ The :class:`ICSEditor` has a very significant performance impact on the
+ structure, and can make subsequent access or modifications on the entity
+ extremely slow due to lazy evaluation. The :class:`ICSEditor` is never used
+ in SWISS-MODEL, ProMod3 or CAMEO. Only open one if you absolutely need to.
+
.. class:: ICSEditor
Inherits :class:`EditorBase`
--
GitLab