diff --git a/modules/mol/base/doc/editors.rst b/modules/mol/base/doc/editors.rst index cc3846a717103c0d5d4eaf081547e33934821143..fcb6c3026a8787a98de0696dda2ae885842408e8 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`