Skip to content

Commit 0f46efa

Browse files
committedJul 14, 2021
docs: 🐛 fix docstring return dictionary keys typo in _license submodule
1 parent b0f6126 commit 0f46efa

File tree

4 files changed

+25
-14
lines changed

4 files changed

+25
-14
lines changed
 

‎_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version = "0.14.0a1.dev0"
1+
version = "0.14.0a2.dev1"

‎docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# Main version number
1717
version = "0.14"
1818
# The full version, including alpha/beta/rc tags
19-
release = "0.14.0-a1"
19+
release = "0.14.0-a2"
2020

2121

2222
# -- General configuration ---------------------------------------------------
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
0.14.0-a2 -- 2021-07-14
2+
-----------------------
3+
4+
5+
📚 Documentation
6+
~~~~~~~~~~~~~~~~~~
7+
8+
- Fix typo for return dictionary keys in _license.py submodule for
9+
:func:`~pyedgeconnect.Orchestrator.get_portal_licensed_appliances` for
10+
licenses as ``enable`` rather than ``enabled``.
11+

‎pyedgeconnect/orch/_license.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ def get_portal_licensed_appliances(self) -> dict:
173173
174174
:return: Returns list of licensed appliances from Cloud Portal \n
175175
[`dict`]: Appliance license information object \n
176-
* keyword **applianceId** (`str`): Appliance id in the format of
177-
integer.NE e.g. ``3.NE``
176+
* keyword **applianceId** (`str`): Appliance id in the
177+
format of integer.NE e.g. ``3.NE``
178178
* keyword **id** (`str`): Not documented
179179
* keyword **enabled** (`bool`): If appliance active
180180
* keyword **hostname** (`str`): Hostname of appliance
@@ -183,13 +183,13 @@ def get_portal_licensed_appliances(self) -> dict:
183183
* keyword **licenses** (`dict`): License state object \n
184184
* keyword **fx** (`dict`): Standard license object \n
185185
* keyword **base** (`dict`): Base license state \n
186-
* keyword **enabled** (`bool`): ``True`` if
186+
* keyword **enable** (`bool`): ``True`` if
187187
active
188188
* keyword **mini** (`dict`): Mini license state \n
189-
* keyword **enabled** (`bool`): ``True`` if
189+
* keyword **enable** (`bool`): ``True`` if
190190
active
191191
* keyword **plus** (`dict`): Plus license state \n
192-
* keyword **enabled** (`bool`): ``True`` if
192+
* keyword **enable** (`bool`): ``True`` if
193193
active
194194
* keyword **tier** (`dict`): Tier license state \n
195195
* keyword **bandwidth** (`int`): Bandwidth
@@ -199,27 +199,27 @@ def get_portal_licensed_appliances(self) -> dict:
199199
* keyword **boost** (`dict`): Boost license state \n
200200
* keyword **bandwidth** (`int`): Amount of boost
201201
bandwidth in Mbps
202-
* keyword **enabled** (`bool`): ``True`` if
202+
* keyword **enable** (`bool`): ``True`` if
203203
active
204204
* keyword **metered** (`dict`): Metered license object \n
205205
* keyword **boost** (`dict`): Boost license state \n
206206
* keyword **bandwidth** (`int`): Amount of boost
207207
bandwidth in Mbps
208-
* keyword **enabled** (`bool`): ``True`` if
208+
* keyword **enable** (`bool`): ``True`` if
209209
active
210210
* keyword **ecsp** (`dict`): Not documented \n
211211
* keyword **licenseId** (`str`): Not documented \n
212212
* keyword **licenseRequest** (`dict`): License requested
213213
state object \n
214214
* keyword **fx** (`dict`): Standard license object \n
215215
* keyword **base** (`dict`): Base license state \n
216-
* keyword **enabled** (`bool`): ``True`` if
216+
* keyword **enable** (`bool`): ``True`` if
217217
active
218218
* keyword **mini** (`dict`): Mini license state \n
219-
* keyword **enabled** (`bool`): ``True`` if
219+
* keyword **enable** (`bool`): ``True`` if
220220
active
221221
* keyword **plus** (`dict`): Plus license state \n
222-
* keyword **enabled** (`bool`): ``True`` if
222+
* keyword **enable** (`bool`): ``True`` if
223223
active
224224
* keyword **tier** (`dict`): Tier license state \n
225225
* keyword **bandwidth** (`int`): Bandwidth
@@ -229,12 +229,12 @@ def get_portal_licensed_appliances(self) -> dict:
229229
* keyword **boost** (`dict`): Boost license state \n
230230
* keyword **bandwidth** (`int`): Amount of boost
231231
bandwidth in Mbps
232-
* keyword **enabled** (`bool`): ``True`` if active
232+
* keyword **enable** (`bool`): ``True`` if active
233233
* keyword **metered** (`dict`): Metered license object \n
234234
* keyword **boost** (`dict`): Boost license state \n
235235
* keyword **bandwidth** (`int`): Amount of boost
236236
bandwidth in Mbps
237-
* keyword **enabled** (`bool`): ``True`` if
237+
* keyword **enable** (`bool`): ``True`` if
238238
active
239239
* keyword **model** (`str`): Hardware model, e.g. ``EC-M-B``
240240
* keyword **portalLicenseType** (`int`): Not documented

0 commit comments

Comments
 (0)