Browse Source

Merge "Fix some reST field lists in docstrings"

Zuul 1 year ago
parent
commit
262025bd2e

+ 13
- 13
functionaltests/cli/v1/behaviors/acl_behaviors.py View File

@@ -57,8 +57,8 @@ class ACLBehaviors(base_behaviors.BaseBehaviors):
57 57
     def acl_delete(self, entity_ref):
58 58
         """Delete a secret or container acl
59 59
 
60
-        :param entity_ref Reference to secret or container entity
61
-        :return If error returns stderr string otherwise returns None.
60
+        :param entity_ref: Reference to secret or container entity
61
+        :return: If error returns stderr string otherwise returns None.
62 62
         """
63 63
         argv = ['acl', 'delete']
64 64
         self.add_auth_and_endpoint(argv)
@@ -74,8 +74,8 @@ class ACLBehaviors(base_behaviors.BaseBehaviors):
74 74
     def acl_get(self, entity_ref):
75 75
         """Get a 'read' ACL setting for a secret or a container.
76 76
 
77
-        :param entity_ref Reference to secret or container entity
78
-        :return dict of 'read' operation ACL settings if found otherwise empty
77
+        :param entity_ref: Reference to secret or container entity
78
+        :return: dict of 'read' operation ACL settings if found otherwise empty
79 79
             dict in case of error.
80 80
         """
81 81
         argv = ['acl', 'get']
@@ -95,14 +95,14 @@ class ACLBehaviors(base_behaviors.BaseBehaviors):
95 95
                    operation_type='read'):
96 96
         """Submits a secret or container ACL
97 97
 
98
-        :param entity_ref Reference to secret or container entity
99
-        :param users List of users for ACL
98
+        :param entity_ref: Reference to secret or container entity
99
+        :param users: List of users for ACL
100 100
         :param project_access: Flag to pass for project access behavior
101 101
         :param use_short_arg: Flag to indicate if use short arguments in cli.
102 102
             Default is False
103 103
         :param operation_type: ACL operation type. Default is 'read' as
104 104
             Barbican currently supports only that type of operation.
105
-        :return dict of 'read' operation ACL settings if found otherwise empty
105
+        :return: dict of 'read' operation ACL settings if found otherwise empty
106 106
             dict in case of error.
107 107
         """
108 108
         argv = ['acl', 'submit']
@@ -128,14 +128,14 @@ class ACLBehaviors(base_behaviors.BaseBehaviors):
128 128
                 operation_type='read'):
129 129
         """Add to a secret or container ACL
130 130
 
131
-        :param entity_ref Reference to secret or container entity
132
-        :param users List of users to be added in ACL
131
+        :param entity_ref: Reference to secret or container entity
132
+        :param users: List of users to be added in ACL
133 133
         :param project_access: Flag to pass for project access behavior
134 134
         :param use_short_arg: Flag to indicate if use short arguments in cli.
135 135
             Default is False
136 136
         :param operation_type: ACL operation type. Default is 'read' as
137 137
             Barbican currently supports only that type of operation.
138
-        :return dict of 'read' operation ACL settings if found otherwise empty
138
+        :return: dict of 'read' operation ACL settings if found otherwise empty
139 139
             dict in case of error.
140 140
         """
141 141
         argv = ['acl', 'user', 'add']
@@ -162,14 +162,14 @@ class ACLBehaviors(base_behaviors.BaseBehaviors):
162 162
                    operation_type='read'):
163 163
         """Remove users from a secret or container ACL
164 164
 
165
-        :param entity_ref Reference to secret or container entity
166
-        :param users List of users to be removed from ACL
165
+        :param entity_ref: Reference to secret or container entity
166
+        :param users: List of users to be removed from ACL
167 167
         :param project_access: Flag to pass for project access behavior
168 168
         :param use_short_arg: Flag to indicate if use short arguments in cli.
169 169
             Default is False
170 170
         :param operation_type: ACL operation type. Default is 'read' as
171 171
             Barbican currently supports only that type of operation.
172
-        :return dict of 'read' operation ACL settings if found otherwise empty
172
+        :return: dict of 'read' operation ACL settings if found otherwise empty
173 173
             dict in case of error.
174 174
         """
175 175
         argv = ['acl', 'user', 'remove']

+ 1
- 1
functionaltests/cli/v1/behaviors/container_behaviors.py View File

@@ -62,7 +62,7 @@ class ContainerBehaviors(base_behaviors.BaseBehaviors):
62 62
         """Get a container
63 63
 
64 64
         :param: the href to a container
65
-        :return dict of container values, or an empty dict if the container
65
+        :return: dict of container values, or an empty dict if the container
66 66
         is not found.
67 67
         """
68 68
         argv = ['secret', 'container', 'get']

+ 2
- 2
functionaltests/cli/v1/behaviors/secret_behaviors.py View File

@@ -83,7 +83,7 @@ class SecretBehaviors(base_behaviors.BaseBehaviors):
83 83
         """Get a secret
84 84
 
85 85
         :param: the href to a secret
86
-        :return dict of secret values, or an empty dict if the secret
86
+        :return: dict of secret values, or an empty dict if the secret
87 87
         is not found.
88 88
         """
89 89
         argv = ['secret', 'get']
@@ -104,7 +104,7 @@ class SecretBehaviors(base_behaviors.BaseBehaviors):
104 104
         :param: the href to a secret
105 105
         :param raw if True then add "-f value" to get raw payload (ie not
106 106
         within a PrettyTable).  If False then omit -f.
107
-        :return string representing the secret payload.
107
+        :return: string representing the secret payload.
108 108
         """
109 109
         argv = ['secret', 'get']
110 110
         self.add_auth_and_endpoint(argv)

+ 1
- 1
functionaltests/utils.py View File

@@ -126,7 +126,7 @@ def create_timestamp_w_tz_and_offset(timezone=None, days=0, hours=0, minutes=0,
126 126
     :param hours: The offset in hours
127 127
     :param minutes: The offset in minutes
128 128
 
129
-    :return a timestamp
129
+    :return: a timestamp
130 130
     """
131 131
     if timezone is None:
132 132
         timezone = time.strftime("%z")

Loading…
Cancel
Save