Skip to content

Commit 4dd1ce7

Browse files
author
Zach Moody
authored
Merge pull request #259 from markkuleinio/choices-doc
Change the example in docstring of Endpoint.choices() to use output from NetBox 2.8.x
2 parents 4687e08 + b6e6167 commit 4dd1ce7

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

pynetbox/core/endpoint.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -295,22 +295,22 @@ def choices(self):
295295
296296
:Returns: Dict containing the available choices.
297297
298-
:Examples:
298+
:Example (from NetBox 2.8.x):
299299
300300
>>> from pprint import pprint
301301
>>> pprint(nb.ipam.ip_addresses.choices())
302-
{'role': [{'display_name': 'Secondary', 'value': 20},
303-
{'display_name': 'VIP', 'value': 40},
304-
{'display_name': 'VRRP', 'value': 41},
305-
{'display_name': 'Loopback', 'value': 10},
306-
{'display_name': 'GLBP', 'value': 43},
307-
{'display_name': 'CARP', 'value': 44},
308-
{'display_name': 'HSRP', 'value': 42},
309-
{'display_name': 'Anycast', 'value': 30}],
310-
'status': [{'display_name': 'Active', 'value': 1},
311-
{'display_name': 'Reserved', 'value': 2},
312-
{'display_name': 'Deprecated', 'value': 3},
313-
{'display_name': 'DHCP', 'value': 5}]}
302+
{'role': [{'display_name': 'Loopback', 'value': 'loopback'},
303+
{'display_name': 'Secondary', 'value': 'secondary'},
304+
{'display_name': 'Anycast', 'value': 'anycast'},
305+
{'display_name': 'VIP', 'value': 'vip'},
306+
{'display_name': 'VRRP', 'value': 'vrrp'},
307+
{'display_name': 'HSRP', 'value': 'hsrp'},
308+
{'display_name': 'GLBP', 'value': 'glbp'},
309+
{'display_name': 'CARP', 'value': 'carp'}],
310+
'status': [{'display_name': 'Active', 'value': 'active'},
311+
{'display_name': 'Reserved', 'value': 'reserved'},
312+
{'display_name': 'Deprecated', 'value': 'deprecated'},
313+
{'display_name': 'DHCP', 'value': 'dhcp'}]}
314314
>>>
315315
"""
316316
if self._choices:

0 commit comments

Comments
 (0)