Skip to content

Commit 6563636

Browse files
author
Touchstone64
committed
Improve the statement of intent when building relational keys
1 parent cfebc5e commit 6563636

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

plexapi/mixins/tv_parent_child.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44
class TvParentChildMixin:
55
""" Mixin for Plex objects that have parent/child relationships (episode/season/show). """
66

7-
def _buildRelationalKey(self, key, **kwargs):
7+
def _buildRelationalKey(self, key, **key_params):
88
""" Returns a key suitable for fetching parent/child TV items
99
1010
Parameters:
1111
key (str): The relational key to be fetched.
12-
**kwargs (dict): Optional relational selection parameters to apply to the
13-
key, for example 'excludeAllLeaves=1'. Additional options (such as XML
14-
filters) should be passed into search functions. See :func:`~plexapi.base.PlexObject.fetchItems`
12+
**key_params (dict): Optional query parameters to add to the key, such as
13+
'excludeAllLeaves=1' or 'index=0'. Additional XML filters should instead
14+
be passed into search functions. See :func:`~plexapi.base.PlexObject.fetchItems`
1515
for details.
1616
1717
"""
1818
if not key:
1919
return None
2020

21-
args = {'includeGuids': 1, **kwargs}
21+
args = {'includeGuids': 1, **key_params}
2222
params = utils.joinArgs(args).lstrip('?')
2323

2424
return f"{key}?{params}"

0 commit comments

Comments
 (0)