Merge pull request #284 from microsoft/dev

5.1.0b5 - fix #280, fix a bunch of spelling in comments

Author: tedchamb

azure-devops/azure/devops/released/build/build_client.py

@@ -614,7 +614,7 @@ def restore_definition(self, project, definition_id, deleted):
     def update_definition(self, definition, project, definition_id, secrets_source_definition_id=None, secrets_source_definition_revision=None):
         """UpdateDefinition.
         Updates an existing definition.
-        :param :class:`<BuildDefinition> <azure.devops.v5_1.build.models.BuildDefinition>` definition: The new version of the defintion.
+        :param :class:`<BuildDefinition> <azure.devops.v5_1.build.models.BuildDefinition>` definition: The new version of the definition.
         :param str project: Project ID or project name
         :param int definition_id: The ID of the definition.
         :param int secrets_source_definition_id:

azure-devops/azure/devops/released/git/git_client_base.py

@@ -1744,7 +1744,7 @@ def update_refs(self, ref_updates, repository_id, project=None, project_id=None)
     def create_repository(self, git_repository_to_create, project=None, source_ref=None):
         """CreateRepository.
         Create a git repository in a team project.
-        :param :class:`<GitRepositoryCreateOptions> <azure.devops.v5_1.git.models.GitRepositoryCreateOptions>` git_repository_to_create: Specify the repo name, team project and/or parent repository. Team project information can be ommitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
+        :param :class:`<GitRepositoryCreateOptions> <azure.devops.v5_1.git.models.GitRepositoryCreateOptions>` git_repository_to_create: Specify the repo name, team project and/or parent repository. Team project information can be omitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
         :param str project: Project ID or project name
         :param str source_ref: [optional] Specify the source refs to use while creating a fork repo
         :rtype: :class:`<GitRepository> <azure.devops.v5_1.git.models.GitRepository>`

azure-devops/azure/devops/released/test/test_client.py

@@ -394,7 +394,7 @@ def get_test_run_by_id(self, project, run_id, include_details=None):
         Get a test run by its ID.
         :param str project: Project ID or project name
         :param int run_id: ID of the run to get.
-        :param bool include_details: Defualt value is true. It includes details like run statistics,release,build,Test enviornment,Post process state and more
+        :param bool include_details: Default value is true. It includes details like run statistics, release, build, test environment, post process state, and more.
         :rtype: :class:`<TestRun> <azure.devops.v5_1.test.models.TestRun>`
         """
         route_values = {}
@@ -460,16 +460,16 @@ def query_test_runs(self, project, min_last_updated_date, max_last_updated_date,
         :param datetime min_last_updated_date: Minimum Last Modified Date of run to be queried (Mandatory).
         :param datetime max_last_updated_date: Maximum Last Modified Date of run to be queried (Mandatory, difference between min and max date can be atmost 7 days).
         :param str state: Current state of the Runs to be queried.
-        :param [int] plan_ids: Plan Ids of the Runs to be queried, comma seperated list of valid ids (limit no. of ids 10).
+        :param [int] plan_ids: Plan Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
         :param bool is_automated: Automation type of the Runs to be queried.
         :param str publish_context: PublishContext of the Runs to be queried.
-        :param [int] build_ids: Build Ids of the Runs to be queried, comma seperated list of valid ids (limit no. of ids 10).
-        :param [int] build_def_ids: Build Definition Ids of the Runs to be queried, comma seperated list of valid ids (limit no. of ids 10).
+        :param [int] build_ids: Build Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
+        :param [int] build_def_ids: Build Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
         :param str branch_name: Source Branch name of the Runs to be queried.
-        :param [int] release_ids: Release Ids of the Runs to be queried, comma seperated list of valid ids (limit no. of ids 10).
-        :param [int] release_def_ids: Release Definition Ids of the Runs to be queried, comma seperated list of valid ids (limit no. of ids 10).
-        :param [int] release_env_ids: Release Environment Ids of the Runs to be queried, comma seperated list of valid ids (limit no. of ids 10).
-        :param [int] release_env_def_ids: Release Environment Definition Ids of the Runs to be queried, comma seperated list of valid ids (limit no. of ids 10).
+        :param [int] release_ids: Release Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
+        :param [int] release_def_ids: Release Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
+        :param [int] release_env_ids: Release Environment Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
+        :param [int] release_env_def_ids: Release Environment Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
         :param str run_title: Run Title of the Runs to be queried.
         :param int top: Number of runs to be queried. Limit is 100
         :param str continuation_token: continuationToken received from previous batch or null for first batch. It is not supposed to be created (or altered, if received from last batch) by user.

azure-devops/azure/devops/released/tfvc/tfvc_client.py

@@ -630,7 +630,7 @@ def get_labels(self, request_data, project=None, top=None, skip=None):
         Get a collection of shallow label references.
         :param :class:`<TfvcLabelRequestData> <azure.devops.v5_1.tfvc.models.TfvcLabelRequestData>` request_data: labelScope, name, owner, and itemLabelFilter
         :param str project: Project ID or project name
-        :param int top: Max number of labels to return
+        :param int top: Max number of labels to return, defaults to 100 when undefined
         :param int skip: Number of labels to skip
         :rtype: [TfvcLabelRef]
         """

azure-devops/azure/devops/released/work/work_client.py

@@ -973,7 +973,7 @@ def get_team_days_off(self, team_context, iteration_id):
     def update_team_days_off(self, days_off_patch, team_context, iteration_id):
         """UpdateTeamDaysOff.
         Set a team's days off for an iteration
-        :param :class:`<TeamSettingsDaysOffPatch> <azure.devops.v5_1.work.models.TeamSettingsDaysOffPatch>` days_off_patch: Team's days off patch containting a list of start and end dates
+        :param :class:`<TeamSettingsDaysOffPatch> <azure.devops.v5_1.work.models.TeamSettingsDaysOffPatch>` days_off_patch: Team's days off patch containing a list of start and end dates
         :param :class:`<TeamContext> <azure.devops.v5_1.work.models.TeamContext>` team_context: The team context for the operation
         :param str iteration_id: ID of the iteration
         :rtype: :class:`<TeamSettingsDaysOff> <azure.devops.v5_1.work.models.TeamSettingsDaysOff>`

azure-devops/azure/devops/v5_0/universal/__init__.py renamed to azure-devops/azure/devops/v5_0/upack_api/__init__.py

@@ -818,7 +818,7 @@ def restore_definition(self, project, definition_id, deleted):
     def update_definition(self, definition, project, definition_id, secrets_source_definition_id=None, secrets_source_definition_revision=None):
         """UpdateDefinition.
         Updates an existing definition.
-        :param :class:`<BuildDefinition> <azure.devops.v5_1.build.models.BuildDefinition>` definition: The new version of the defintion.
+        :param :class:`<BuildDefinition> <azure.devops.v5_1.build.models.BuildDefinition>` definition: The new version of the definition.
         :param str project: Project ID or project name
         :param int definition_id: The ID of the definition.
         :param int secrets_source_definition_id:

azure-devops/azure/devops/v5_0/universal/models.py renamed to azure-devops/azure/devops/v5_0/upack_api/models.py

@@ -137,7 +137,7 @@ class ContributionConstraint(Model):
     :type name: str
     :param properties: Properties that are fed to the contribution filter class
     :type properties: :class:`object <azure.devops.v5_1.contributions.models.object>`
-    :param relationships: Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will elimiate the contribution from the tree completely if the constraint is applied.
+    :param relationships: Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.
     :type relationships: list of str
     """
 

azure-devops/azure/devops/v5_0/universal/universal_client.py renamed to azure-devops/azure/devops/v5_0/upack_api/upack_api_client.py

@@ -127,7 +127,7 @@ class ContributionConstraint(Model):
     :type name: str
     :param properties: Properties that are fed to the contribution filter class
     :type properties: :class:`object <azure.devops.v5_1.extension_management.models.object>`
-    :param relationships: Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will elimiate the contribution from the tree completely if the constraint is applied.
+    :param relationships: Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.
     :type relationships: list of str
     """
 

azure-devops/azure/devops/v5_1/build/build_client.py

@@ -1619,7 +1619,7 @@ def create_review(self, review, pub_name, ext_name):
     def delete_review(self, pub_name, ext_name, review_id):
         """DeleteReview.
         [Preview API] Deletes a review
-        :param str pub_name: Name of the pubilsher who published the extension
+        :param str pub_name: Name of the publisher who published the extension
         :param str ext_name: Name of the extension
         :param long review_id: Id of the review which needs to be updated
         """
@@ -1639,7 +1639,7 @@ def update_review(self, review_patch, pub_name, ext_name, review_id):
         """UpdateReview.
         [Preview API] Updates or Flags a review
         :param :class:`<ReviewPatch> <azure.devops.v5_1.gallery.models.ReviewPatch>` review_patch: ReviewPatch object which contains the changes to be applied to the review
-        :param str pub_name: Name of the pubilsher who published the extension
+        :param str pub_name: Name of the publisher who published the extension
         :param str ext_name: Name of the extension
         :param long review_id: Id of the review which needs to be updated
         :rtype: :class:`<ReviewPatch> <azure.devops.v5_1.gallery.models.ReviewPatch>`

azure-devops/azure/devops/v5_1/contributions/models.py

@@ -326,7 +326,7 @@ class ExtensionCategory(Model):
     :type category_id: int
     :param category_name: This is the internal name for a category
     :type category_name: str
-    :param language: This parameter is obsolete. Refer to LanguageTitles for langauge specific titles
+    :param language: This parameter is obsolete. Refer to LanguageTitles for language specific titles
     :type language: str
     :param language_titles: The list of all the titles of this category in various languages
     :type language_titles: list of :class:`CategoryLanguageTitle <azure.devops.v5_1.gallery.models.CategoryLanguageTitle>`
@@ -1414,7 +1414,7 @@ class QueryFilter(Model):
     :type page_number: int
     :param page_size: The page size defines the number of results the caller wants for this filter. The count can't exceed the overall query size limits.
     :type page_size: int
-    :param paging_token: The paging token is a distinct type of filter and the other filter fields are ignored. The paging token represents the continuation of a previously executed query. The information about where in the result and what fields are being filtered are embeded in the token.
+    :param paging_token: The paging token is a distinct type of filter and the other filter fields are ignored. The paging token represents the continuation of a previously executed query. The information about where in the result and what fields are being filtered are embedded in the token.
     :type paging_token: str
     :param sort_by: Defines the type of sorting to be applied on the results. The page slice is cut of the sorted results only.
     :type sort_by: int

azure-devops/azure/devops/v5_1/extension_management/models.py

@@ -2937,7 +2937,7 @@ def get_ref_favorites(self, project, repository_id=None, identity_id=None):
     def create_repository(self, git_repository_to_create, project=None, source_ref=None):
         """CreateRepository.
         Create a git repository in a team project.
-        :param :class:`<GitRepositoryCreateOptions> <azure.devops.v5_1.git.models.GitRepositoryCreateOptions>` git_repository_to_create: Specify the repo name, team project and/or parent repository. Team project information can be ommitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
+        :param :class:`<GitRepositoryCreateOptions> <azure.devops.v5_1.git.models.GitRepositoryCreateOptions>` git_repository_to_create: Specify the repo name, team project and/or parent repository. Team project information can be omitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
         :param str project: Project ID or project name
         :param str source_ref: [optional] Specify the source refs to use while creating a fork repo
         :rtype: :class:`<GitRepository> <azure.devops.v5_1.git.models.GitRepository>`

azure-devops/azure/devops/v5_1/gallery/gallery_client.py

@@ -1578,7 +1578,7 @@ class GitPullRequestCompletionOptions(Model):
     :type merge_commit_message: str
     :param merge_strategy: Specify the strategy used to merge the pull request during completion. If MergeStrategy is not set to any value, a no-FF merge will be created if SquashMerge == false. If MergeStrategy is not set to any value, the pull request commits will be squash if SquashMerge == true. The SquashMerge member is deprecated. It is recommended that you explicitly set MergeStrategy in all cases. If an explicit value is provided for MergeStrategy, the SquashMerge member will be ignored.
     :type merge_strategy: object
-    :param squash_merge: SquashMerge is deprecated. You should explicity set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.
+    :param squash_merge: SquashMerge is deprecated. You should explicitly set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.
     :type squash_merge: bool
     :param transition_work_items: If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved)
     :type transition_work_items: bool
@@ -2470,7 +2470,7 @@ class GitTreeDiff(Model):
     """
     :param base_tree_id: ObjectId of the base tree of this diff.
     :type base_tree_id: str
-    :param diff_entries: List of tree entries that differ between the base and target tree.  Renames and object type changes are returned as a delete for the old object and add for the new object.  If a continuation token is returned in the response header, some tree entries are yet to be processed and may yeild more diff entries. If the continuation token is not returned all the diff entries have been included in this response.
+    :param diff_entries: List of tree entries that differ between the base and target tree.  Renames and object type changes are returned as a delete for the old object and add for the new object.  If a continuation token is returned in the response header, some tree entries are yet to be processed and may yield more diff entries. If the continuation token is not returned all the diff entries have been included in this response.
     :type diff_entries: list of :class:`GitTreeDiffEntry <azure.devops.v5_1.git.models.GitTreeDiffEntry>`
     :param target_tree_id: ObjectId of the target tree of this diff.
     :type target_tree_id: str

azure-devops/azure/devops/v5_1/gallery/models.py

@@ -136,7 +136,7 @@ def get_group_members(self, group_id, max_results=None, paging_token=None):
         [Preview API] Get direct members of a Group.
         :param str group_id: Id of the Group.
         :param int max_results: Maximum number of results to retrieve.
-        :param str paging_token: Paging Token from the previous page fetched. If the 'pagingToken' is null, the results would be fetched from the begining of the Members List.
+        :param str paging_token: Paging Token from the previous page fetched. If the 'pagingToken' is null, the results would be fetched from the beginning of the Members List.
         :rtype: :class:`<PagedGraphMemberList> <azure.devops.v5_1.member_entitlement_management.models.PagedGraphMemberList>`
         """
         route_values = {}

azure-devops/azure/devops/v5_1/git/git_client_base.py

@@ -489,7 +489,7 @@ def __init__(self, id=None, name=None):
 
 class UserEntitlement(Model):
     """
-    A user entity with additional properties including thier license, extensions, and project membership
+    A user entity with additional properties including their license, extensions, and project membership
 
     :param access_level: User's access level denoted by a license.
     :type access_level: :class:`AccessLevel <azure.devops.v5_1.member_entitlement_management.models.AccessLevel>`

azure-devops/azure/devops/v5_1/git/models.py

@@ -1260,7 +1260,7 @@ def __init__(self, address=None, type=None, use_custom_address=None):
 
 class SubscriptionDiagnostics(Model):
     """
-    Contains all the diagonstics settings for a subscription.
+    Contains all the diagnostics settings for a subscription.
 
     :param delivery_results: Diagnostics settings for retaining delivery results.  Used for Service Hooks subscriptions.
     :type delivery_results: :class:`SubscriptionTracing <azure.devops.v5_1.notification.models.SubscriptionTracing>`

azure-devops/azure/devops/v5_1/member_entitlement_management/member_entitlement_management_client.py

@@ -897,7 +897,7 @@ class PublisherEvent(Model):
     """
     Wrapper around an event which is being published
 
-    :param diagnostics: Add key/value pairs which will be stored with a published notification in the SH service DB.  This key/value pairs are for diagnostic purposes only and will have not effect on the delivery of a notificaton.
+    :param diagnostics: Add key/value pairs which will be stored with a published notification in the SH service DB.  This key/value pairs are for diagnostic purposes only and will have not effect on the delivery of a notification.
     :type diagnostics: dict
     :param event: The event being published
     :type event: :class:`Event <azure.devops.v5_1.service_hooks.models.Event>`
@@ -1121,7 +1121,7 @@ def __init__(self, _links=None, action_description=None, consumer_action_id=None
 
 class SubscriptionDiagnostics(Model):
     """
-    Contains all the diagonstics settings for a subscription.
+    Contains all the diagnostics settings for a subscription.
 
     :param delivery_results: Diagnostics settings for retaining delivery results.  Used for Service Hooks subscriptions.
     :type delivery_results: :class:`SubscriptionTracing <azure.devops.v5_1.microsoft._visual_studio._services._notifications._web_api.models.SubscriptionTracing>`

azure-devops/azure/devops/v5_1/member_entitlement_management/models.py

@@ -366,7 +366,7 @@ class CloneOperationInformation(Model):
     :type source_plan: :class:`ShallowReference <azure.devops.v5_1.test.models.ShallowReference>`
     :param source_project: Shallow reference of the source
     :type source_project: :class:`ShallowReference <azure.devops.v5_1.test.models.ShallowReference>`
-    :param state: Current state of the operation. When State reaches Suceeded or Failed, the operation is complete
+    :param state: Current state of the operation. When State reaches Succeeded or Failed, the operation is complete
     :type state: object
     :param url: Url for getting the clone information
     :type url: str