From 2ac84412dcc8acada5ddf8200ecb456cf2efdeb2 Mon Sep 17 00:00:00 2001 From: J0J0 Todos Date: Mon, 23 Sep 2024 19:08:36 +0200 Subject: [PATCH] importhistory: Rewrite docs intro text --- docs/plugins/importhistory.rst | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/plugins/importhistory.rst b/docs/plugins/importhistory.rst index 622f389367..34a2444079 100644 --- a/docs/plugins/importhistory.rst +++ b/docs/plugins/importhistory.rst @@ -1,16 +1,13 @@ ImportHistory Plugin ==================== -The ``importhistory`` plugin is a simple plugin that adds a `source_path` field -to every item imported to your library. It is useful when you import many -directories in a bulk, and you want to keep track of the directories you -already imported. - -Another feature of the plugin is suggesting the user to delete the source -paths of items you remove from your beets library. This is useful if you keep -backups of your imports in their original source paths by using `beet import ---copy`, and you want to delete their backup when you regret the imports -altogether. +The ``importhistory`` plugin adds a `source_path` field to every item imported +to the library which stores the original media files' paths. Using this plugin +makes most sense when the general importing workflow is to use ``beet import +--copy``. + +Another feature of the plugin is suggesting to delete those original source +files as well whenever items are removed from the Beets library. To use the ``importhistory`` plugin, enable it in your configuration (see :ref:`using-plugins`).