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
     """