Skip to content

Commit 72f9fcf

Browse files
committed
Update outdated --help of import basic command
1 parent 35f5b0b commit 72f9fcf

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

discodos/cmd23/import_.py

+19-15
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,25 @@ def import_group():
3939
@import_group.command(name='basic')
4040
@click.pass_obj
4141
def import_basic_cmd(helper ):
42-
"""Initially imports a Discogs collection.
43-
44-
A very basic subset of the Discogs collection data is imported to the
45-
DiscoBASE. Currently this includes artist, release title, catalog number, a
46-
timestamp of the import time, and the flags is_in_d_collection and sold.
47-
48-
The basic import can be re-run any time. It
49-
overwrites any existing data in the release table of the DiscoBASE, though
50-
additional information like the sales date is not overwritten when present
51-
already.
52-
53-
The purpose of the is_in_d_collection flag marks releases that are not in
54-
the online Discogs collection anymore with a 0 (false). This helps to get
55-
the releases table in sync when releases have been removed using the Discogs
56-
web interface.
42+
"""Initially imports Discogs release and user collection data.
43+
44+
A basic subset of the details of all releases in the user's Discogs collection is
45+
imported into the DiscoBASE. Currently this includes artist, release title, catalog
46+
number, and the time of import. Information about collection items is also stored.
47+
This includes folders, notes, added date and rating (not all is made use of in
48+
DiscoDOS yet).
49+
50+
The basic import can be re-run any time. Existing releases data is updated. Note
51+
that releases are not deleted on re-runs because they might still be used by the
52+
`sales` or `mixes` features of DiscoDOS. If "orphaned" collection item's are found,
53+
they are marked as such and won't show up in views anymore (e.g `dsc ls`). Orphaned
54+
in that context means: Not in the user's (online) collection anymore (e.g removed
55+
via the Discogs webinterface).
56+
57+
To manually remove releases from the DiscoBASE anyway, use
58+
`dsc import release -d <release_id>`. This is able to remove them from the offline
59+
collection, the (online) Discogs collection and purge any release data from the
60+
DiscoBASE.
5761
"""
5862
def update_user_interaction_helper(user):
5963
log.debug("Entered collection and details import mode.")

0 commit comments

Comments
 (0)