From 568fedd74a1a38581b070487a6b973180fdab730 Mon Sep 17 00:00:00 2001 From: Fred Gleason Date: Mon, 21 Jan 2019 16:37:24 -0500 Subject: [PATCH] 2019-01-21 Fred Gleason * Updated comments in 'pypad.Receiver::serviceDescription()' and 'pypad.Receiver::padField()' methods to caution against confusing the two. --- ChangeLog | 4 ++++ apis/pypad/api/pypad.py | 8 +++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index a4e328dd..58024a6b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -18410,3 +18410,7 @@ * Fixed a path bug in the Console Helper configuration that broke startup of rdalsaconfig(8) and rddbconfig(8) from the desktop menu when using default --prefix= value. +2019-01-21 Fred Gleason + * Updated comments in 'pypad.Receiver::serviceDescription()' and + 'pypad.Receiver::padField()' methods to caution against confusing + the two. diff --git a/apis/pypad/api/pypad.py b/apis/pypad/api/pypad.py index bf5f0fac..c6c6cb7c 100644 --- a/apis/pypad/api/pypad.py +++ b/apis/pypad/api/pypad.py @@ -333,7 +333,8 @@ class Update(object): def serviceDescription(self): """ Returns the description of the service associated with this update - (string). + (string). Not to be confused with the 'description' field for a + cut! """ return self.__fields['padUpdate']['service']['description'] @@ -475,8 +476,9 @@ class Update(object): pypad.FIELD_COMPOSER - The 'Composer' field (string) pypad.FIELD_CONDUCTOR - The 'Conductor' field (string) pypad.FIELD_CUT_NUMER - The 'Cut Number' field (integer) - pypad.FIELD_DESCRIPTION - The 'Description' field - (string) + pypad.FIELD_DESCRIPTION - The cut 'Description' field + (string). Not to be confused + with the service description! pypad.FIELD_EXTERNAL_ANNC_TYPE - The 'EXT_ANNC_TYPE' field (string) pypad.FIELD_EXTERNAL_DATA - The 'EXT_DATA' field