From 369629bea5059c7955ffaaeb4214be5aac0885e8 Mon Sep 17 00:00:00 2001 From: Dorian Soergel Date: Mon, 3 Jun 2019 17:20:36 +0200 Subject: [PATCH] clarifying docstrings --- beetsplug/parentwork.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/beetsplug/parentwork.py b/beetsplug/parentwork.py index 41b4fa461..00c6635db 100644 --- a/beetsplug/parentwork.py +++ b/beetsplug/parentwork.py @@ -13,8 +13,8 @@ # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. -"""Gets work title, disambiguation, parent work and its disambiguation, -composer, composer sort name and performers +"""Gets parent work, its disambiguation and id, composer, composer sort name +and work composition date """ from __future__ import division, absolute_import, print_function @@ -27,7 +27,10 @@ import musicbrainzngs def work_father_id(mb_workid, work_date=None): """ Given a mb_workid, find the id one of the works the work is part of - and the first composition date it encounters. """ + and the first composition date it encounters. + + For a give work, hat we call father_work is the work it is part of. + The parent_work is the furthest ancestor.""" work_info = musicbrainzngs.get_work_by_id(mb_workid, includes=["work-rels", "artist-rels"])