Skip to content

Commit a0e0881

Browse files
committed
docstring fixups
1 parent f25a38c commit a0e0881

1 file changed

Lines changed: 16 additions & 9 deletions

File tree

f5/bigip/resource.py

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@
2222
2323
Examples:
2424
25-
* Expression: bigip = BigIP('a', 'b', 'c')
26-
* URI Returned: https://a/mgmt/tm/
25+
* Expression: bigip = ManagementRoot('a', 'b', 'c')
26+
* URI Returned: https://a/mgmt/
2727
28-
* Expression: bigip.ltm
28+
* Expression: bigip.tm.ltm
2929
* URI Returned: https://a/mgmt/tm/ltm/
3030
31-
* Expression: pools1 = bigip.ltm.pools
31+
* Expression: pools1 = bigip.tm.ltm.pools
3232
* URI Returned: https://a/mgmt/tm/ltm/pool
3333
3434
* Expression: pool_a = pools1.create(partition="Common", name="foo")
@@ -40,7 +40,7 @@
4040
We refer to a server-provided resource as a "service". Thus far all URI
4141
referenced resources are "services" in this sense.
4242
43-
We use methods named Create, Refresh, Update, Load, and Delete to manipulate
43+
We use methods named Create, Refresh, Update, Load, Modify, and Delete to manipulate
4444
BIG-IP® device services.
4545
4646
Methods:
@@ -53,16 +53,23 @@
5353
and sets the Resource attrs to the state the device reports
5454
* load -- uses HTTP GET, obtains the state of an existing resource on the
5555
device and sets the Resource attrs to that state
56+
* modify -- uses HTTP PATCH to selectively modify named resources submitted
57+
as keyword arguments
5658
* delete -- uses HTTP DELETE, removes the resource from the device, and sets
5759
self.__dict__ to {'deleted': True}
5860
5961
Available Classes:
62+
* PathElement -- the most fundamental class it represent URI elements that
63+
serve only as place-holders. All other Resources inherit from
64+
PathElement, though the inheritance may be indirect. PathElement provides
65+
a constructor to match its call in LazyAttributeMixin.__getattr__. The
66+
expected behavior is that all resource subclasses depend on this
67+
constructor to correctly set their self._meta_data['uri']. See
68+
_set_meta_data_uri for the logic underlying self._meta_data['uri']
69+
construction.
6070
* ResourceBase -- only `refresh` is generally supported in all resource
6171
types, this class provides `refresh`. ResourceBase objects are usually
62-
instantiated via setting lazy attributes. ResourceBase provides a
63-
constructor to match its call in LazyAttributeMixin.__getattr__. The
64-
expected behavior is that all resource subclasses depend on this
65-
constructor to correctly set their self._meta_data['uri'].
72+
instantiated via setting lazy attributes.
6673
All ResourceBase objects (except BIG-IPs) have a container (BIG-IPs
6774
contain themselves). The container is the object the ResourceBase is an
6875
attribute of.

0 commit comments

Comments
 (0)