Skip to content

Commit 2dd57ca

Browse files
cmlcciecmlccie
authored
Merge pull request #59 from UniversalSuperBox/docs-no-warnings
Documentation - Fix warnings, add to CI
2 parents 86ddb6a + 52cd876 commit 2dd57ca

File tree

17 files changed

+39
-38
lines changed

17 files changed

+39
-38
lines changed

‎Makefile‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ buildpackage : setup.py
1010

1111
.PHONY : docs
1212
docs : docs/Makefile
13-
cd docs/ && $(MAKE) html
13+
cd docs/ && $(MAKE) html SPHINXOPTS="-W"
1414

1515

1616
# Local project directory and environment management recipes
@@ -38,8 +38,7 @@ ci-init :
3838
pipenv install
3939

4040
.PHONY : ci
41-
ci :
42-
pipenv run pytest -m "not ratelimit"
41+
ci : pytest docs
4342

4443
.PHONY : toxtest
4544
toxtest : tox.ini

‎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: 3 additions & 3 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.
@@ -137,7 +137,7 @@ def create(self, roomId=None, toPersonId=None, toPersonEmail=None,
137137
specified this parameter may be optionally used to provide
138138
alternate text for UI clients that do not support rich text.
139139
markdown(basestring): The message, in markdown format.
140-
files(list): A list of public URL(s) or local path(s) to files to
140+
files(`list`): A list of public URL(s) or local path(s) to files to
141141
be posted into the room. Only one file is allowed per message.
142142
Uploaded files are automatically converted into a format that
143143
all Spark clients can render.
@@ -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: 7 additions & 7 deletions
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.
@@ -123,16 +123,16 @@ def create(self, emails, displayName=None, firstName=None, lastName=None,
123123
Only an admin can create a new user account.
124124
125125
Args:
126-
emails(list): Email address(es) of the person (list of strings).
126+
emails(`list`): Email address(es) of the person (list of strings).
127127
displayName(basestring): Full name of the person.
128128
firstName(basestring): First name of the person.
129129
lastName(basestring): Last name of the person.
130130
avatar(basestring): URL to the person's avatar in PNG format.
131131
orgId(basestring): ID of the organization to which this
132132
person belongs.
133-
roles(list): Roles of the person (list of strings containing
133+
roles(`list`): Roles of the person (list of strings containing
134134
the role IDs to be assigned to the person).
135-
licenses(list): Licenses allocated to the person (list of
135+
licenses(`list`): Licenses allocated to the person (list of
136136
strings - containing the license IDs to be allocated to the
137137
person).
138138
**request_parameters: Additional request parameters (provides
@@ -211,16 +211,16 @@ def update(self, personId, emails=None, displayName=None, firstName=None,
211211
212212
Args:
213213
personId(basestring): The person ID.
214-
emails(list): Email address(es) of the person (list of strings).
214+
emails(`list`): Email address(es) of the person (list of strings).
215215
displayName(basestring): Full name of the person.
216216
firstName(basestring): First name of the person.
217217
lastName(basestring): Last name of the person.
218218
avatar(basestring): URL to the person's avatar in PNG format.
219219
orgId(basestring): ID of the organization to which this
220220
person belongs.
221-
roles(list): Roles of the person (list of strings containing
221+
roles(`list`): Roles of the person (list of strings containing
222222
the role IDs to be assigned to the person).
223-
licenses(list): Licenses allocated to the person (list of
223+
licenses(`list`): Licenses allocated to the person (list of
224224
strings - containing the license IDs to be allocated to the
225225
person).
226226
**request_parameters: Additional request parameters (provides

‎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.

0 commit comments

Comments
 (0)