Skip to content

Commit

Permalink
importhistory: Rewrite docs intro text
Browse files Browse the repository at this point in the history
  • Loading branch information
JOJ0 committed Sep 23, 2024
1 parent c9588ab commit 2ac8441
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions docs/plugins/importhistory.rst
Original file line number Diff line number Diff line change
@@ -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`).
Expand Down

0 comments on commit 2ac8441

Please sign in to comment.