From 2b504a9a8135445cb495812823034a6d988f940d Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Tue, 9 Jul 2024 14:22:17 +0200
Subject: [PATCH] doc: show how to create a buffered XCS editor

---
 modules/mol/base/doc/editors.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/modules/mol/base/doc/editors.rst b/modules/mol/base/doc/editors.rst
index 01214c4b3..7dfc823d6 100644
--- a/modules/mol/base/doc/editors.rst
+++ b/modules/mol/base/doc/editors.rst
@@ -44,8 +44,12 @@ 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.
+  recommended to use the external coordinate system :class:`XCSEditor` with
+  buffering for performance reasons:
+
+  .. code-block:: python
+    
+    editor = entity.EditXCS(ost.mol.EditMode.BUFFERED_EDIT)
 
 .. class::  EditorBase
   
-- 
GitLab