Skip to content

Commit 7098d6f

Browse files
tedchambtedchamb
committed
fix up doc strings
1 parent 66fbb1b commit 7098d6f

File tree

142 files changed

+4090
-4702
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+4090
-4702
lines changed

‎azure-devops/azure/devops/v4_0/accounts/accounts_client.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ def __init__(self, base_url=None, creds=None):
2727

2828
def create_account(self, info, use_precreated=None):
2929
"""CreateAccount.
30-
:param :class:`<AccountCreateInfoInternal> <accounts.v4_0.models.AccountCreateInfoInternal>` info:
30+
:param :class:`<AccountCreateInfoInternal> <azure.devops.v4_0.accounts.models.AccountCreateInfoInternal>` info:
3131
:param bool use_precreated:
32-
:rtype: :class:`<Account> <accounts.v4_0.models.Account>`
32+
:rtype: :class:`<Account> <azure.devops.v4_0.accounts.models.Account>`
3333
"""
3434
query_parameters = {}
3535
if use_precreated is not None:
@@ -45,7 +45,7 @@ def create_account(self, info, use_precreated=None):
4545
def get_account(self, account_id):
4646
"""GetAccount.
4747
:param str account_id:
48-
:rtype: :class:`<Account> <accounts.v4_0.models.Account>`
48+
:rtype: :class:`<Account> <azure.devops.v4_0.accounts.models.Account>`
4949
"""
5050
route_values = {}
5151
if account_id is not None:

‎azure-devops/azure/devops/v4_0/accounts/models.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class Account(Model):
4141
:param organization_name: Organization that created the account
4242
:type organization_name: str
4343
:param properties: Extended properties
44-
:type properties: :class:`object <accounts.v4_0.models.object>`
44+
:type properties: :class:`object <azure.devops.v4_0.accounts.models.object>`
4545
:param status_reason: Reason for current status
4646
:type status_reason: str
4747
"""
@@ -95,9 +95,9 @@ class AccountCreateInfoInternal(Model):
9595
:param organization:
9696
:type organization: str
9797
:param preferences:
98-
:type preferences: :class:`AccountPreferencesInternal <accounts.v4_0.models.AccountPreferencesInternal>`
98+
:type preferences: :class:`AccountPreferencesInternal <azure.devops.v4_0.accounts.models.AccountPreferencesInternal>`
9999
:param properties:
100-
:type properties: :class:`object <accounts.v4_0.models.object>`
100+
:type properties: :class:`object <azure.devops.v4_0.accounts.models.object>`
101101
:param service_definitions:
102102
:type service_definitions: list of { key: str; value: str }
103103
"""

‎azure-devops/azure/devops/v4_0/build/build_client.py‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ def __init__(self, base_url=None, creds=None):
2828
def create_artifact(self, artifact, build_id, project=None):
2929
"""CreateArtifact.
3030
Associates an artifact with a build
31-
:param :class:`<BuildArtifact> <build.v4_0.models.BuildArtifact>` artifact:
31+
:param :class:`<BuildArtifact> <azure.devops.v4_0.build.models.BuildArtifact>` artifact:
3232
:param int build_id:
3333
:param str project: Project ID or project name
34-
:rtype: :class:`<BuildArtifact> <build.v4_0.models.BuildArtifact>`
34+
:rtype: :class:`<BuildArtifact> <azure.devops.v4_0.build.models.BuildArtifact>`
3535
"""
3636
route_values = {}
3737
if project is not None:
@@ -52,7 +52,7 @@ def get_artifact(self, build_id, artifact_name, project=None):
5252
:param int build_id:
5353
:param str artifact_name:
5454
:param str project: Project ID or project name
55-
:rtype: :class:`<BuildArtifact> <build.v4_0.models.BuildArtifact>`
55+
:rtype: :class:`<BuildArtifact> <azure.devops.v4_0.build.models.BuildArtifact>`
5656
"""
5757
route_values = {}
5858
if project is not None:
@@ -144,7 +144,7 @@ def get_build_badge(self, project, repo_type, repo_id=None, branch_name=None):
144144
:param str repo_type:
145145
:param str repo_id:
146146
:param str branch_name:
147-
:rtype: :class:`<BuildBadge> <build.v4_0.models.BuildBadge>`
147+
:rtype: :class:`<BuildBadge> <azure.devops.v4_0.build.models.BuildBadge>`
148148
"""
149149
route_values = {}
150150
if project is not None:
@@ -211,7 +211,7 @@ def get_build(self, build_id, project=None, property_filters=None):
211211
:param int build_id:
212212
:param str project: Project ID or project name
213213
:param str property_filters: A comma-delimited list of properties to include in the results
214-
:rtype: :class:`<Build> <build.v4_0.models.Build>`
214+
:rtype: :class:`<Build> <azure.devops.v4_0.build.models.Build>`
215215
"""
216216
route_values = {}
217217
if project is not None:
@@ -313,11 +313,11 @@ def get_builds(self, project=None, definitions=None, queues=None, build_number=N
313313
def queue_build(self, build, project=None, ignore_warnings=None, check_in_ticket=None):
314314
"""QueueBuild.
315315
Queues a build
316-
:param :class:`<Build> <build.v4_0.models.Build>` build:
316+
:param :class:`<Build> <azure.devops.v4_0.build.models.Build>` build:
317317
:param str project: Project ID or project name
318318
:param bool ignore_warnings:
319319
:param str check_in_ticket:
320-
:rtype: :class:`<Build> <build.v4_0.models.Build>`
320+
:rtype: :class:`<Build> <azure.devops.v4_0.build.models.Build>`
321321
"""
322322
route_values = {}
323323
if project is not None:
@@ -339,10 +339,10 @@ def queue_build(self, build, project=None, ignore_warnings=None, check_in_ticket
339339
def update_build(self, build, build_id, project=None):
340340
"""UpdateBuild.
341341
Updates a build
342-
:param :class:`<Build> <build.v4_0.models.Build>` build:
342+
:param :class:`<Build> <azure.devops.v4_0.build.models.Build>` build:
343343
:param int build_id:
344344
:param str project: Project ID or project name
345-
:rtype: :class:`<Build> <build.v4_0.models.Build>`
345+
:rtype: :class:`<Build> <azure.devops.v4_0.build.models.Build>`
346346
"""
347347
route_values = {}
348348
if project is not None:
@@ -434,7 +434,7 @@ def get_build_controller(self, controller_id):
434434
"""GetBuildController.
435435
Gets a controller
436436
:param int controller_id:
437-
:rtype: :class:`<BuildController> <build.v4_0.models.BuildController>`
437+
:rtype: :class:`<BuildController> <azure.devops.v4_0.build.models.BuildController>`
438438
"""
439439
route_values = {}
440440
if controller_id is not None:
@@ -463,11 +463,11 @@ def get_build_controllers(self, name=None):
463463
def create_definition(self, definition, project=None, definition_to_clone_id=None, definition_to_clone_revision=None):
464464
"""CreateDefinition.
465465
Creates a new definition
466-
:param :class:`<BuildDefinition> <build.v4_0.models.BuildDefinition>` definition:
466+
:param :class:`<BuildDefinition> <azure.devops.v4_0.build.models.BuildDefinition>` definition:
467467
:param str project: Project ID or project name
468468
:param int definition_to_clone_id:
469469
:param int definition_to_clone_revision:
470-
:rtype: :class:`<BuildDefinition> <build.v4_0.models.BuildDefinition>`
470+
:rtype: :class:`<BuildDefinition> <azure.devops.v4_0.build.models.BuildDefinition>`
471471
"""
472472
route_values = {}
473473
if project is not None:
@@ -511,7 +511,7 @@ def get_definition(self, definition_id, project=None, revision=None, min_metrics
511511
:param datetime min_metrics_time:
512512
:param [str] property_filters:
513513
:param bool include_latest_builds:
514-
:rtype: :class:`<BuildDefinition> <build.v4_0.models.BuildDefinition>`
514+
:rtype: :class:`<BuildDefinition> <azure.devops.v4_0.build.models.BuildDefinition>`
515515
"""
516516
route_values = {}
517517
if project is not None:
@@ -598,12 +598,12 @@ def get_definitions(self, project=None, name=None, repository_id=None, repositor
598598
def update_definition(self, definition, definition_id, project=None, secrets_source_definition_id=None, secrets_source_definition_revision=None):
599599
"""UpdateDefinition.
600600
Updates an existing definition
601-
:param :class:`<BuildDefinition> <build.v4_0.models.BuildDefinition>` definition:
601+
:param :class:`<BuildDefinition> <azure.devops.v4_0.build.models.BuildDefinition>` definition:
602602
:param int definition_id:
603603
:param str project: Project ID or project name
604604
:param int secrets_source_definition_id:
605605
:param int secrets_source_definition_revision:
606-
:rtype: :class:`<BuildDefinition> <build.v4_0.models.BuildDefinition>`
606+
:rtype: :class:`<BuildDefinition> <azure.devops.v4_0.build.models.BuildDefinition>`
607607
"""
608608
route_values = {}
609609
if project is not None:
@@ -627,10 +627,10 @@ def update_definition(self, definition, definition_id, project=None, secrets_sou
627627
def create_folder(self, folder, project, path):
628628
"""CreateFolder.
629629
[Preview API] Creates a new folder
630-
:param :class:`<Folder> <build.v4_0.models.Folder>` folder:
630+
:param :class:`<Folder> <azure.devops.v4_0.build.models.Folder>` folder:
631631
:param str project: Project ID or project name
632632
:param str path:
633-
:rtype: :class:`<Folder> <build.v4_0.models.Folder>`
633+
:rtype: :class:`<Folder> <azure.devops.v4_0.build.models.Folder>`
634634
"""
635635
route_values = {}
636636
if project is not None:
@@ -687,10 +687,10 @@ def get_folders(self, project, path=None, query_order=None):
687687
def update_folder(self, folder, project, path):
688688
"""UpdateFolder.
689689
[Preview API] Updates an existing folder at given existing path
690-
:param :class:`<Folder> <build.v4_0.models.Folder>` folder:
690+
:param :class:`<Folder> <azure.devops.v4_0.build.models.Folder>` folder:
691691
:param str project: Project ID or project name
692692
:param str path:
693-
:rtype: :class:`<Folder> <build.v4_0.models.Folder>`
693+
:rtype: :class:`<Folder> <azure.devops.v4_0.build.models.Folder>`
694694
"""
695695
route_values = {}
696696
if project is not None:
@@ -876,7 +876,7 @@ def get_build_properties(self, project, build_id, filter=None):
876876
:param str project: Project ID or project name
877877
:param int build_id: The build id.
878878
:param [str] filter: Filter to specific properties. Defaults to all properties.
879-
:rtype: :class:`<object> <build.v4_0.models.object>`
879+
:rtype: :class:`<object> <azure.devops.v4_0.build.models.object>`
880880
"""
881881
route_values = {}
882882
if project is not None:
@@ -897,10 +897,10 @@ def get_build_properties(self, project, build_id, filter=None):
897897
def update_build_properties(self, document, project, build_id):
898898
"""UpdateBuildProperties.
899899
[Preview API] Updates properties for a build.
900-
:param :class:`<[JsonPatchOperation]> <build.v4_0.models.[JsonPatchOperation]>` document:
900+
:param :class:`<[JsonPatchOperation]> <azure.devops.v4_0.build.models.[JsonPatchOperation]>` document:
901901
:param str project: Project ID or project name
902902
:param int build_id: The build id.
903-
:rtype: :class:`<object> <build.v4_0.models.object>`
903+
:rtype: :class:`<object> <azure.devops.v4_0.build.models.object>`
904904
"""
905905
route_values = {}
906906
if project is not None:
@@ -922,7 +922,7 @@ def get_definition_properties(self, project, definition_id, filter=None):
922922
:param str project: Project ID or project name
923923
:param int definition_id: The definition id.
924924
:param [str] filter: Filter to specific properties. Defaults to all properties.
925-
:rtype: :class:`<object> <build.v4_0.models.object>`
925+
:rtype: :class:`<object> <azure.devops.v4_0.build.models.object>`
926926
"""
927927
route_values = {}
928928
if project is not None:
@@ -943,10 +943,10 @@ def get_definition_properties(self, project, definition_id, filter=None):
943943
def update_definition_properties(self, document, project, definition_id):
944944
"""UpdateDefinitionProperties.
945945
[Preview API] Updates properties for a definition.
946-
:param :class:`<[JsonPatchOperation]> <build.v4_0.models.[JsonPatchOperation]>` document:
946+
:param :class:`<[JsonPatchOperation]> <azure.devops.v4_0.build.models.[JsonPatchOperation]>` document:
947947
:param str project: Project ID or project name
948948
:param int definition_id: The definition id.
949-
:rtype: :class:`<object> <build.v4_0.models.object>`
949+
:rtype: :class:`<object> <azure.devops.v4_0.build.models.object>`
950950
"""
951951
route_values = {}
952952
if project is not None:
@@ -968,7 +968,7 @@ def get_build_report(self, project, build_id, type=None):
968968
:param str project: Project ID or project name
969969
:param int build_id:
970970
:param str type:
971-
:rtype: :class:`<BuildReportMetadata> <build.v4_0.models.BuildReportMetadata>`
971+
:rtype: :class:`<BuildReportMetadata> <azure.devops.v4_0.build.models.BuildReportMetadata>`
972972
"""
973973
route_values = {}
974974
if project is not None:
@@ -1016,7 +1016,7 @@ def get_build_report_html_content(self, project, build_id, type=None, **kwargs):
10161016
def get_resource_usage(self):
10171017
"""GetResourceUsage.
10181018
[Preview API]
1019-
:rtype: :class:`<BuildResourceUsage> <build.v4_0.models.BuildResourceUsage>`
1019+
:rtype: :class:`<BuildResourceUsage> <azure.devops.v4_0.build.models.BuildResourceUsage>`
10201020
"""
10211021
response = self._send(http_method='GET',
10221022
location_id='3813d06c-9e36-4ea1-aac3-61a485d60e3d',
@@ -1044,7 +1044,7 @@ def get_definition_revisions(self, project, definition_id):
10441044
def get_build_settings(self):
10451045
"""GetBuildSettings.
10461046
Gets the build settings
1047-
:rtype: :class:`<BuildSettings> <build.v4_0.models.BuildSettings>`
1047+
:rtype: :class:`<BuildSettings> <azure.devops.v4_0.build.models.BuildSettings>`
10481048
"""
10491049
response = self._send(http_method='GET',
10501050
location_id='aa8c1c9c-ef8b-474a-b8c4-785c7b191d0d',
@@ -1054,8 +1054,8 @@ def get_build_settings(self):
10541054
def update_build_settings(self, settings):
10551055
"""UpdateBuildSettings.
10561056
Updates the build settings
1057-
:param :class:`<BuildSettings> <build.v4_0.models.BuildSettings>` settings:
1058-
:rtype: :class:`<BuildSettings> <build.v4_0.models.BuildSettings>`
1057+
:param :class:`<BuildSettings> <azure.devops.v4_0.build.models.BuildSettings>` settings:
1058+
:rtype: :class:`<BuildSettings> <azure.devops.v4_0.build.models.BuildSettings>`
10591059
"""
10601060
content = self._serialize.body(settings, 'BuildSettings')
10611061
response = self._send(http_method='PATCH',
@@ -1267,7 +1267,7 @@ def get_template(self, project, template_id):
12671267
Gets definition template filtered by id
12681268
:param str project: Project ID or project name
12691269
:param str template_id: Id of the requested template.
1270-
:rtype: :class:`<BuildDefinitionTemplate> <build.v4_0.models.BuildDefinitionTemplate>`
1270+
:rtype: :class:`<BuildDefinitionTemplate> <azure.devops.v4_0.build.models.BuildDefinitionTemplate>`
12711271
"""
12721272
route_values = {}
12731273
if project is not None:
@@ -1298,10 +1298,10 @@ def get_templates(self, project):
12981298
def save_template(self, template, project, template_id):
12991299
"""SaveTemplate.
13001300
Saves a definition template
1301-
:param :class:`<BuildDefinitionTemplate> <build.v4_0.models.BuildDefinitionTemplate>` template:
1301+
:param :class:`<BuildDefinitionTemplate> <azure.devops.v4_0.build.models.BuildDefinitionTemplate>` template:
13021302
:param str project: Project ID or project name
13031303
:param str template_id:
1304-
:rtype: :class:`<BuildDefinitionTemplate> <build.v4_0.models.BuildDefinitionTemplate>`
1304+
:rtype: :class:`<BuildDefinitionTemplate> <azure.devops.v4_0.build.models.BuildDefinitionTemplate>`
13051305
"""
13061306
route_values = {}
13071307
if project is not None:
@@ -1324,7 +1324,7 @@ def get_build_timeline(self, project, build_id, timeline_id=None, change_id=None
13241324
:param str timeline_id:
13251325
:param int change_id:
13261326
:param str plan_id:
1327-
:rtype: :class:`<Timeline> <build.v4_0.models.Timeline>`
1327+
:rtype: :class:`<Timeline> <azure.devops.v4_0.build.models.Timeline>`
13281328
"""
13291329
route_values = {}
13301330
if project is not None:

0 commit comments

Comments
 (0)