Skip to content

Commit 6d8d585

Browse files
committed
add hpecp/license doc check
Signed-off-by: Chris Snow <[email protected]>
1 parent 883074d commit 6d8d585

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
install:
3737
- pip3 install flake8 flake8-docstrings flake8-per-file-ignores
3838
script:
39-
- flake8 --exclude hpecp/gateway.py,hpecp/logger.py,hpecp/k8s_cluster.py,hpecp/license.py,hpecp/user.py,hpecp/tenant.py,hpecp/role.py --docstring-convention numpy bin/ hpecp/
39+
- flake8 --exclude hpecp/gateway.py,hpecp/logger.py,hpecp/k8s_cluster.py,hpecp/user.py,hpecp/tenant.py,hpecp/role.py --docstring-convention numpy bin/ hpecp/
4040
- stage: coverage_library
4141
name: "Code coverage LIBRARY (./hpecp)"
4242
python: 3.8

hpecp/license.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,18 @@ def upload_with_ssh_pass(
8080
)
8181

8282
def register(self, server_filename):
83-
"""Register a license that has been uploaded to
84-
'/srv/bluedata/license/' on the controller.
85-
86-
Arguments:
87-
88-
server_filename: str
89-
Filepath to the license on the server, e.g.
90-
'/srv/bluedata/license/LICENSE-1.txt'
91-
92-
Raises:
93-
94-
APIException
83+
"""Register a license. The license must have previously been uploaded
84+
to '/srv/bluedata/license/' on the controller.
85+
86+
Parameters
87+
----------
88+
server_filename: str
89+
Filepath to the license on the server, e.g.
90+
'/srv/bluedata/license/LICENSE-1.txt'
91+
92+
Raises
93+
------
94+
APIException
9595
"""
9696
data = {"hpelicense_file": server_filename}
9797
return self.client._request(
@@ -102,16 +102,16 @@ def register(self, server_filename):
102102
)
103103

104104
def delete(self, license_key):
105-
"""Delete a license by LicenseKey
106-
107-
Arguments:
108-
109-
license_key: str
110-
The license key, e.g. '1234 1234 ... 1234 "SOMETEXT"'
105+
"""Delete a license by LicenseKey.
111106
112-
Raises:
107+
Parameters
108+
----------
109+
license_key: str
110+
The license key, e.g. '1234 1234 ... 1234 "SOMETEXT"'
113111
114-
APIException
112+
Raises
113+
------
114+
APIException
115115
"""
116116

117117
try:

0 commit comments

Comments
 (0)