Skip to content

Commit 2721600

Browse files
committed
fix comments that had incorrect return type info
1 parent 70286fa commit 2721600

File tree

37 files changed

+402
-402
lines changed

37 files changed

+402
-402
lines changed

azure-devops/azure/devops/released/cloud_load_test/cloud_load_test_client.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def __init__(self, base_url=None, creds=None):
2828
def create_agent_group(self, group):
2929
"""CreateAgentGroup.
3030
:param :class:`<AgentGroup> <azure.devops.v5_0.cloud_load_test.models.AgentGroup>` group: Agent group to be created
31-
:rtype: :class:`<AgentGroup> <azure.devops.v5_0.cloud-load-test.models.AgentGroup>`
31+
:rtype: :class:`<AgentGroup> <azure.devops.v5_0.cloud_load_test.models.AgentGroup>`
3232
"""
3333
content = self._serialize.body(group, 'AgentGroup')
3434
response = self._send(http_method='POST',
@@ -106,7 +106,7 @@ def get_static_agents(self, agent_group_id, agent_name=None):
106106
def get_application(self, application_id):
107107
"""GetApplication.
108108
:param str application_id: Filter by APM application identifier.
109-
:rtype: :class:`<Application> <azure.devops.v5_0.cloud-load-test.models.Application>`
109+
:rtype: :class:`<Application> <azure.devops.v5_0.cloud_load_test.models.Application>`
110110
"""
111111
route_values = {}
112112
if application_id is not None:
@@ -174,7 +174,7 @@ def get_counter_samples(self, counter_sample_query_details, test_run_id):
174174
"""GetCounterSamples.
175175
:param :class:`<VssJsonCollectionWrapper> <azure.devops.v5_0.cloud_load_test.models.VssJsonCollectionWrapper>` counter_sample_query_details:
176176
:param str test_run_id: The test run identifier
177-
:rtype: :class:`<CounterSamplesResult> <azure.devops.v5_0.cloud-load-test.models.CounterSamplesResult>`
177+
:rtype: :class:`<CounterSamplesResult> <azure.devops.v5_0.cloud_load_test.models.CounterSamplesResult>`
178178
"""
179179
route_values = {}
180180
if test_run_id is not None:
@@ -193,7 +193,7 @@ def get_load_test_run_errors(self, test_run_id, type=None, sub_type=None, detail
193193
:param str type: Filter for the particular type of errors.
194194
:param str sub_type: Filter for a particular subtype of errors. You should not provide error subtype without error type.
195195
:param bool detailed: To include the details of test errors such as messagetext, request, stacktrace, testcasename, scenarioname, and lasterrordate.
196-
:rtype: :class:`<LoadTestErrors> <azure.devops.v5_0.cloud-load-test.models.LoadTestErrors>`
196+
:rtype: :class:`<LoadTestErrors> <azure.devops.v5_0.cloud_load_test.models.LoadTestErrors>`
197197
"""
198198
route_values = {}
199199
if test_run_id is not None:
@@ -229,7 +229,7 @@ def get_test_run_messages(self, test_run_id):
229229
def get_plugin(self, type):
230230
"""GetPlugin.
231231
:param str type: Currently ApplicationInsights is the only available plugin type.
232-
:rtype: :class:`<ApplicationType> <azure.devops.v5_0.cloud-load-test.models.ApplicationType>`
232+
:rtype: :class:`<ApplicationType> <azure.devops.v5_0.cloud_load_test.models.ApplicationType>`
233233
"""
234234
route_values = {}
235235
if type is not None:
@@ -252,7 +252,7 @@ def get_plugins(self):
252252
def get_load_test_result(self, test_run_id):
253253
"""GetLoadTestResult.
254254
:param str test_run_id: The test run identifier
255-
:rtype: :class:`<TestResults> <azure.devops.v5_0.cloud-load-test.models.TestResults>`
255+
:rtype: :class:`<TestResults> <azure.devops.v5_0.cloud_load_test.models.TestResults>`
256256
"""
257257
route_values = {}
258258
if test_run_id is not None:
@@ -266,7 +266,7 @@ def get_load_test_result(self, test_run_id):
266266
def create_test_definition(self, test_definition):
267267
"""CreateTestDefinition.
268268
:param :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>` test_definition: Test definition to be created
269-
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud-load-test.models.TestDefinition>`
269+
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>`
270270
"""
271271
content = self._serialize.body(test_definition, 'TestDefinition')
272272
response = self._send(http_method='POST',
@@ -278,7 +278,7 @@ def create_test_definition(self, test_definition):
278278
def get_test_definition(self, test_definition_id):
279279
"""GetTestDefinition.
280280
:param str test_definition_id: The test definition identifier
281-
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud-load-test.models.TestDefinition>`
281+
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>`
282282
"""
283283
route_values = {}
284284
if test_definition_id is not None:
@@ -312,7 +312,7 @@ def get_test_definitions(self, from_date=None, to_date=None, top=None):
312312
def update_test_definition(self, test_definition):
313313
"""UpdateTestDefinition.
314314
:param :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>` test_definition:
315-
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud-load-test.models.TestDefinition>`
315+
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>`
316316
"""
317317
content = self._serialize.body(test_definition, 'TestDefinition')
318318
response = self._send(http_method='PUT',
@@ -324,7 +324,7 @@ def update_test_definition(self, test_definition):
324324
def create_test_drop(self, web_test_drop):
325325
"""CreateTestDrop.
326326
:param :class:`<TestDrop> <azure.devops.v5_0.cloud_load_test.models.TestDrop>` web_test_drop: Test drop to be created
327-
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud-load-test.models.TestDrop>`
327+
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud_load_test.models.TestDrop>`
328328
"""
329329
content = self._serialize.body(web_test_drop, 'TestDrop')
330330
response = self._send(http_method='POST',
@@ -336,7 +336,7 @@ def create_test_drop(self, web_test_drop):
336336
def get_test_drop(self, test_drop_id):
337337
"""GetTestDrop.
338338
:param str test_drop_id: The test drop identifier
339-
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud-load-test.models.TestDrop>`
339+
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud_load_test.models.TestDrop>`
340340
"""
341341
route_values = {}
342342
if test_drop_id is not None:
@@ -350,7 +350,7 @@ def get_test_drop(self, test_drop_id):
350350
def create_test_run(self, web_test_run):
351351
"""CreateTestRun.
352352
:param :class:`<TestRun> <azure.devops.v5_0.cloud_load_test.models.TestRun>` web_test_run:
353-
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud-load-test.models.TestRun>`
353+
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud_load_test.models.TestRun>`
354354
"""
355355
content = self._serialize.body(web_test_run, 'TestRun')
356356
response = self._send(http_method='POST',
@@ -362,7 +362,7 @@ def create_test_run(self, web_test_run):
362362
def get_test_run(self, test_run_id):
363363
"""GetTestRun.
364364
:param str test_run_id: Unique ID of the test run
365-
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud-load-test.models.TestRun>`
365+
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud_load_test.models.TestRun>`
366366
"""
367367
route_values = {}
368368
if test_run_id is not None:

azure-devops/azure/devops/released/service_hooks/service_hooks_client.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def get_consumer_action(self, consumer_id, consumer_action_id, publisher_id=None
3131
:param str consumer_id: ID for a consumer.
3232
:param str consumer_action_id: ID for a consumerActionId.
3333
:param str publisher_id:
34-
:rtype: :class:`<ConsumerAction> <azure.devops.v5_0.service-hooks.models.ConsumerAction>`
34+
:rtype: :class:`<ConsumerAction> <azure.devops.v5_0.service_hooks.models.ConsumerAction>`
3535
"""
3636
route_values = {}
3737
if consumer_id is not None:
@@ -73,7 +73,7 @@ def get_consumer(self, consumer_id, publisher_id=None):
7373
Get a specific consumer service. Optionally filter out consumer actions that do not support any event types for the specified publisher.
7474
:param str consumer_id: ID for a consumer.
7575
:param str publisher_id:
76-
:rtype: :class:`<Consumer> <azure.devops.v5_0.service-hooks.models.Consumer>`
76+
:rtype: :class:`<Consumer> <azure.devops.v5_0.service_hooks.models.Consumer>`
7777
"""
7878
route_values = {}
7979
if consumer_id is not None:
@@ -108,7 +108,7 @@ def get_event_type(self, publisher_id, event_type_id):
108108
Get a specific event type.
109109
:param str publisher_id: ID for a publisher.
110110
:param str event_type_id:
111-
:rtype: :class:`<EventTypeDescriptor> <azure.devops.v5_0.service-hooks.models.EventTypeDescriptor>`
111+
:rtype: :class:`<EventTypeDescriptor> <azure.devops.v5_0.service_hooks.models.EventTypeDescriptor>`
112112
"""
113113
route_values = {}
114114
if publisher_id is not None:
@@ -141,7 +141,7 @@ def get_notification(self, subscription_id, notification_id):
141141
Get a specific notification for a subscription.
142142
:param str subscription_id: ID for a subscription.
143143
:param int notification_id:
144-
:rtype: :class:`<Notification> <azure.devops.v5_0.service-hooks.models.Notification>`
144+
:rtype: :class:`<Notification> <azure.devops.v5_0.service_hooks.models.Notification>`
145145
"""
146146
route_values = {}
147147
if subscription_id is not None:
@@ -184,7 +184,7 @@ def query_notifications(self, query):
184184
"""QueryNotifications.
185185
Query for notifications. A notification includes details about the event, the request to and the response from the consumer service.
186186
:param :class:`<NotificationsQuery> <azure.devops.v5_0.service_hooks.models.NotificationsQuery>` query:
187-
:rtype: :class:`<NotificationsQuery> <azure.devops.v5_0.service-hooks.models.NotificationsQuery>`
187+
:rtype: :class:`<NotificationsQuery> <azure.devops.v5_0.service_hooks.models.NotificationsQuery>`
188188
"""
189189
content = self._serialize.body(query, 'NotificationsQuery')
190190
response = self._send(http_method='POST',
@@ -197,7 +197,7 @@ def query_input_values(self, input_values_query, publisher_id):
197197
"""QueryInputValues.
198198
:param :class:`<InputValuesQuery> <azure.devops.v5_0.service_hooks.models.InputValuesQuery>` input_values_query:
199199
:param str publisher_id:
200-
:rtype: :class:`<InputValuesQuery> <azure.devops.v5_0.service-hooks.models.InputValuesQuery>`
200+
:rtype: :class:`<InputValuesQuery> <azure.devops.v5_0.service_hooks.models.InputValuesQuery>`
201201
"""
202202
route_values = {}
203203
if publisher_id is not None:
@@ -214,7 +214,7 @@ def get_publisher(self, publisher_id):
214214
"""GetPublisher.
215215
Get a specific service hooks publisher.
216216
:param str publisher_id: ID for a publisher.
217-
:rtype: :class:`<Publisher> <azure.devops.v5_0.service-hooks.models.Publisher>`
217+
:rtype: :class:`<Publisher> <azure.devops.v5_0.service_hooks.models.Publisher>`
218218
"""
219219
route_values = {}
220220
if publisher_id is not None:
@@ -239,7 +239,7 @@ def query_publishers(self, query):
239239
"""QueryPublishers.
240240
Query for service hook publishers.
241241
:param :class:`<PublishersQuery> <azure.devops.v5_0.service_hooks.models.PublishersQuery>` query:
242-
:rtype: :class:`<PublishersQuery> <azure.devops.v5_0.service-hooks.models.PublishersQuery>`
242+
:rtype: :class:`<PublishersQuery> <azure.devops.v5_0.service_hooks.models.PublishersQuery>`
243243
"""
244244
content = self._serialize.body(query, 'PublishersQuery')
245245
response = self._send(http_method='POST',
@@ -252,7 +252,7 @@ def create_subscription(self, subscription):
252252
"""CreateSubscription.
253253
Create a subscription.
254254
:param :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>` subscription: Subscription to be created.
255-
:rtype: :class:`<Subscription> <azure.devops.v5_0.service-hooks.models.Subscription>`
255+
:rtype: :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>`
256256
"""
257257
content = self._serialize.body(subscription, 'Subscription')
258258
response = self._send(http_method='POST',
@@ -278,7 +278,7 @@ def get_subscription(self, subscription_id):
278278
"""GetSubscription.
279279
Get a specific service hooks subscription.
280280
:param str subscription_id: ID for a subscription.
281-
:rtype: :class:`<Subscription> <azure.devops.v5_0.service-hooks.models.Subscription>`
281+
:rtype: :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>`
282282
"""
283283
route_values = {}
284284
if subscription_id is not None:
@@ -318,7 +318,7 @@ def replace_subscription(self, subscription, subscription_id=None):
318318
Update a subscription. <param name="subscriptionId">ID for a subscription that you wish to update.</param>
319319
:param :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>` subscription:
320320
:param str subscription_id:
321-
:rtype: :class:`<Subscription> <azure.devops.v5_0.service-hooks.models.Subscription>`
321+
:rtype: :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>`
322322
"""
323323
route_values = {}
324324
if subscription_id is not None:
@@ -335,7 +335,7 @@ def create_subscriptions_query(self, query):
335335
"""CreateSubscriptionsQuery.
336336
Query for service hook subscriptions.
337337
:param :class:`<SubscriptionsQuery> <azure.devops.v5_0.service_hooks.models.SubscriptionsQuery>` query:
338-
:rtype: :class:`<SubscriptionsQuery> <azure.devops.v5_0.service-hooks.models.SubscriptionsQuery>`
338+
:rtype: :class:`<SubscriptionsQuery> <azure.devops.v5_0.service_hooks.models.SubscriptionsQuery>`
339339
"""
340340
content = self._serialize.body(query, 'SubscriptionsQuery')
341341
response = self._send(http_method='POST',
@@ -349,7 +349,7 @@ def create_test_notification(self, test_notification, use_real_data=None):
349349
Sends a test notification. This is useful for verifying the configuration of an updated or new service hooks subscription.
350350
:param :class:`<Notification> <azure.devops.v5_0.service_hooks.models.Notification>` test_notification:
351351
:param bool use_real_data: Only allow testing with real data in existing subscriptions.
352-
:rtype: :class:`<Notification> <azure.devops.v5_0.service-hooks.models.Notification>`
352+
:rtype: :class:`<Notification> <azure.devops.v5_0.service_hooks.models.Notification>`
353353
"""
354354
query_parameters = {}
355355
if use_real_data is not None:

0 commit comments

Comments
 (0)