Add documentation of sync-rename functions.

petermao · Jun 27, 2023 · f2d5188 · f2d5188
1 parent 0541dd9
commit f2d5188
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.org b/README.org
@@ -105,6 +105,12 @@
      the document to annotate.
 
 *** new (all formats)
+    - ~org-noter-enable-sync-renames~ :: Optional feature to update document
+      paths when renaming or moving document files or notes files.  This allows
+      you to change your mind later about the names and locations of your
+      document files and notes files without having to manually update all the
+      links.
+
     - ~org-noter-toggle-notes-window-location~ (~M-T~) :: Toggle between
       horizontal and vertical document/notes layout.
 

diff --git a/org-noter-core.el b/org-noter-core.el
@@ -2530,7 +2530,9 @@ Enables `org-noter--sync-doc-rename-in-notes' and
 `dired-rename-file'.
 
 In dired, this affects the renaming of supported document files
-and .org files."
+and .org files.
+
+This feature can be turn off with `org-noter-disable-sync-renames'."
   (interactive)
   (advice-add 'dired-rename-file :after 'org-noter--sync-doc-rename-in-notes)
   (advice-add 'dired-rename-file :after 'org-noter--sync-notes-rename-in-notes))