Skip to content

Commit 52cd876

Browse files
Fix wrapping of Returns: items
1 parent a69e3cf commit 52cd876

12 files changed

+23
-23
lines changed

ciscosparkapi/api/access_tokens.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def get(self, client_id, client_secret, code, redirect_uri):
9696
9797
Returns:
9898
ciscosparkapi.AccessToken: An AccessToken object with the access
99-
token provided by the Cisco Spark cloud.
99+
token provided by the Cisco Spark cloud.
100100
101101
Raises:
102102
TypeError: If the parameter types are incorrect.
@@ -137,7 +137,7 @@ def refresh(self, client_id, client_secret, refresh_token):
137137
138138
Returns:
139139
AccessToken: With the access token provided by the Cisco Spark
140-
cloud.
140+
cloud.
141141
142142
Raises:
143143
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/events.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def list(self, resource=None, type=None, actorId=None, _from=None, to=None,
9696
9797
Returns:
9898
GeneratorContainer: A GeneratorContainer which, when iterated,
99-
yields the events returned by the Cisco Spark query.
99+
yields the events returned by the Cisco Spark query.
100100
101101
Raises:
102102
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/licenses.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def list(self, orgId=None, max=None, **request_parameters):
8383
8484
Returns:
8585
GeneratorContainer: A GeneratorContainer which, when iterated,
86-
yields the licenses returned by the Cisco Spark query.
86+
yields the licenses returned by the Cisco Spark query.
8787
8888
Raises:
8989
TypeError: If the parameter types are incorrect.
@@ -114,7 +114,7 @@ def get(self, licenseId):
114114
115115
Returns:
116116
License: A License object with the details of the requested
117-
License.
117+
License.
118118
119119
Raises:
120120
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/memberships.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def list(self, roomId=None, personId=None, personEmail=None, max=None,
9393
9494
Returns:
9595
GeneratorContainer: A GeneratorContainer which, when iterated,
96-
yields the memberships returned by the Cisco Spark query.
96+
yields the memberships returned by the Cisco Spark query.
9797
9898
Raises:
9999
TypeError: If the parameter types are incorrect.
@@ -137,7 +137,7 @@ def create(self, roomId, personId=None, personEmail=None,
137137
138138
Returns:
139139
Membership: A Membership object with the details of the created
140-
membership.
140+
membership.
141141
142142
Raises:
143143
TypeError: If the parameter types are incorrect.
@@ -171,7 +171,7 @@ def get(self, membershipId):
171171
172172
Returns:
173173
Membership: A Membership object with the details of the requested
174-
membership.
174+
membership.
175175
176176
Raises:
177177
TypeError: If the parameter types are incorrect.
@@ -197,7 +197,7 @@ def update(self, membershipId, isModerator=None, **request_parameters):
197197
198198
Returns:
199199
Membership: A Membership object with the updated Spark membership
200-
details.
200+
details.
201201
202202
Raises:
203203
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/messages.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def list(self, roomId, mentionedPeople=None, before=None,
9090
9191
Returns:
9292
GeneratorContainer: A GeneratorContainer which, when iterated,
93-
yields the messages returned by the Cisco Spark query.
93+
yields the messages returned by the Cisco Spark query.
9494
9595
Raises:
9696
TypeError: If the parameter types are incorrect.
@@ -213,7 +213,7 @@ def get(self, messageId):
213213
214214
Returns:
215215
Message: A Message object with the details of the requested
216-
message.
216+
message.
217217
218218
Raises:
219219
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/organizations.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def list(self, max=None, **request_parameters):
7979
8080
Returns:
8181
GeneratorContainer: A GeneratorContainer which, when iterated,
82-
yields the organizations returned by the Cisco Spark query.
82+
yields the organizations returned by the Cisco Spark query.
8383
8484
Raises:
8585
TypeError: If the parameter types are incorrect.
@@ -108,7 +108,7 @@ def get(self, orgId):
108108
109109
Returns:
110110
Organization: An Organization object with the details of the
111-
requested organization.
111+
requested organization.
112112
113113
Raises:
114114
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/people.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def list(self, email=None, displayName=None, id=None, orgId=None, max=None,
8686
8787
Returns:
8888
GeneratorContainer: A GeneratorContainer which, when iterated,
89-
yields the people returned by the Cisco Spark query.
89+
yields the people returned by the Cisco Spark query.
9090
9191
Raises:
9292
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/roles.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def list(self, max=None, **request_parameters):
7979
8080
Returns:
8181
GeneratorContainer: A GeneratorContainer which, when iterated,
82-
yields the roles returned by the Cisco Spark query.
82+
yields the roles returned by the Cisco Spark query.
8383
8484
Raises:
8585
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/rooms.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def list(self, teamId=None, type=None, sortBy=None, max=None,
9090
9191
Returns:
9292
GeneratorContainer: A GeneratorContainer which, when iterated,
93-
yields the rooms returned by the Cisco Spark query.
93+
yields the rooms returned by the Cisco Spark query.
9494
9595
Raises:
9696
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/team_memberships.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ def list(self, teamId, max=None, **request_parameters):
8080
8181
Returns:
8282
GeneratorContainer: A GeneratorContainer which, when iterated,
83-
yields the team memberships returned by the Cisco Spark query.
83+
yields the team memberships returned by the Cisco Spark query.
8484
8585
Raises:
8686
TypeError: If the parameter types are incorrect.
@@ -121,7 +121,7 @@ def create(self, teamId, personId=None, personEmail=None,
121121
122122
Returns:
123123
TeamMembership: A TeamMembership object with the details of the
124-
created team membership.
124+
created team membership.
125125
126126
Raises:
127127
TypeError: If the parameter types are incorrect.
@@ -155,7 +155,7 @@ def get(self, membershipId):
155155
156156
Returns:
157157
TeamMembership: A TeamMembership object with the details of the
158-
requested team membership.
158+
requested team membership.
159159
160160
Raises:
161161
TypeError: If the parameter types are incorrect.
@@ -181,7 +181,7 @@ def update(self, membershipId, isModerator=None, **request_parameters):
181181
182182
Returns:
183183
TeamMembership: A TeamMembership object with the updated Spark team
184-
membership details.
184+
membership details.
185185
186186
Raises:
187187
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/teams.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def list(self, max=None, **request_parameters):
7979
8080
Returns:
8181
GeneratorContainer: A GeneratorContainer which, when iterated,
82-
yields the teams returned by the Cisco Spark query.
82+
yields the teams returned by the Cisco Spark query.
8383
8484
Raises:
8585
TypeError: If the parameter types are incorrect.

ciscosparkapi/api/webhooks.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def list(self, max=None, **request_parameters):
7979
8080
Returns:
8181
GeneratorContainer: A GeneratorContainer which, when iterated,
82-
yields the webhooks returned by the Cisco Spark query.
82+
yields the webhooks returned by the Cisco Spark query.
8383
8484
Raises:
8585
TypeError: If the parameter types are incorrect.
@@ -154,7 +154,7 @@ def get(self, webhookId):
154154
155155
Returns:
156156
Webhook: A Webhook object with the details of the requested
157-
webhook.
157+
webhook.
158158
159159
Raises:
160160
TypeError: If the parameter types are incorrect.

0 commit comments

Comments
 (0)