Skip to content

Commit d71ce73

Browse files
authored
update docstring
update docstrings for usage of `inviteFriend` and `updateFriend`. Previous doc suggested that if `None` then all sections were selected. If `None` no sections will be selected.
1 parent 9ce0d17 commit d71ce73

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

plexapi/myplex.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,8 @@ def inviteFriend(self, user, server, sections=None, allowSync=False, allowCamera
199199
Parameters:
200200
user (str): MyPlexUser, username, email of the user to be added.
201201
server (PlexServer): PlexServer object or machineIdentifier containing the library sections to share.
202-
sections ([Section]): Library sections, names or ids to be shared (default None shares all sections).
202+
sections ([Section]): Library sections, names or ids to be shared (default None).
203+
[Section] must be defined in order to update shared sections.
203204
allowSync (Bool): Set True to allow user to sync content.
204205
allowCameraUpload (Bool): Set True to allow user to upload photos.
205206
allowChannels (Bool): Set True to allow user to utilize installed channels.
@@ -247,7 +248,8 @@ def updateFriend(self, user, server, sections=None, removeSections=False, allowS
247248
Parameters:
248249
user (str): MyPlexUser, username, email of the user to be added.
249250
server (PlexServer): PlexServer object or machineIdentifier containing the library sections to share.
250-
sections: ([Section]): Library sections, names or ids to be shared (default None shares all sections).
251+
sections: ([Section]): Library sections, names or ids to be shared (default None).
252+
[Section] must be defined in order to update shared sections.
251253
removeSections (Bool): Set True to remove all shares. Supersedes sections.
252254
allowSync (Bool): Set True to allow user to sync content.
253255
allowCameraUpload (Bool): Set True to allow user to upload photos.

0 commit comments

Comments
 (0)