2019-01-21 Fred Gleason <fredg@paravelsystems.com>

* Updated comments in 'pypad.Receiver::serviceDescription()' and
	'pypad.Receiver::padField()' methods to caution against confusing
	the two.
This commit is contained in:
Fred Gleason 2019-01-21 16:37:24 -05:00
parent 6e45c0b624
commit 568fedd74a
2 changed files with 9 additions and 3 deletions

View File

@ -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 <fredg@paravelsystems.com>
* Updated comments in 'pypad.Receiver::serviceDescription()' and
'pypad.Receiver::padField()' methods to caution against confusing
the two.

View File

@ -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