[tepl] Dumb FileSaver docs: make the view non-editable

[Sébastien Wilmet <swilmet src gnome org>]

commit aaa84bb24c19381cc25d49e850807409f2dc1a12
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Wed May 13 14:29:26 2020 +0200

    Dumb FileSaver docs: make the view non-editable

 tepl/tepl-file-saver.c | 11 +++++++++++
 1 file changed, 11 insertions(+)
---
diff --git a/tepl/tepl-file-saver.c b/tepl/tepl-file-saver.c
index b1ac444..335ab0d 100644
--- a/tepl/tepl-file-saver.c
+++ b/tepl/tepl-file-saver.c
@@ -20,6 +20,17 @@
  * A file saver should be used only for one save operation, including errors
  * handling. If an error occurs, you can reconfigure the saver and relaunch the
  * operation with tepl_file_saver_save_async().
+ *
+ * # Things that need to be done at a higher level
+ *
+ * Make the #GtkTextView non-editable during the save operation. See
+ * gtk_text_view_set_editable(). Because the save operation is asynchronous, and
+ * gtk_text_buffer_set_modified() must be called (with a %FALSE value) only when
+ * the file has been successfully saved. So that's why
+ * gtk_text_buffer_set_modified() is called by tepl_file_saver_save_finish(),
+ * not at the beginning of the save operation. If the view/buffer is editable
+ * during the save operation, gtk_text_buffer_set_modified() may be called at
+ * the wrong place in the undo/redo history.
  */
 
 enum