Merge pull request #840 from annatisch/docstring_formatting

Python docstring formatting updates
Azure · Mar 14, 2016 · 8d5a0fa · 8d5a0fa
2 parents e60a95e + fd1492c
commit 8d5a0fa
Show file tree

Hide file tree

Showing 199 changed files with 4,799 additions and 2,065 deletions.
diff --git a/...nceTests/AzureBodyDuration/autorestdurationtestservice/auto_rest_duration_test_service.py b/...nceTests/AzureBodyDuration/autorestdurationtestservice/auto_rest_duration_test_service.py
@@ -23,7 +23,8 @@ class AutoRestDurationTestServiceConfiguration(AzureConfiguration):
     attributes.
 
     :param credentials: Gets Azure subscription credentials.
-    :type credentials: credentials
+    :type credentials: :mod:`A msrestazure Credentials
+     object<msrestazure.azure_active_directory>`
     :param accept_language: Gets or sets the preferred language for the
      response.
     :type accept_language: str

diff --git a/...ts/Expected/AcceptanceTests/AzureBodyDuration/autorestdurationtestservice/models/error.py b/...ts/Expected/AcceptanceTests/AzureBodyDuration/autorestdurationtestservice/models/error.py
@@ -16,8 +16,10 @@
 class Error(Model):
     """Error
 
-    :param int status:
-    :param str message:
+    :param status:
+    :type status: int
+    :param message:
+    :type message: str
     """ 
 
     _attribute_map = {

diff --git a/...anceTests/AzureBodyDuration/autorestdurationtestservice/operations/duration_operations.py b/...anceTests/AzureBodyDuration/autorestdurationtestservice/operations/duration_operations.py
@@ -38,10 +38,13 @@ def get_null(
         Get null duration value
 
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: timedelta
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         # Construct URL
         url = '/duration/null'
@@ -85,10 +88,13 @@ def put_positive_duration(
         :param duration_body:
         :type duration_body: timedelta
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: None
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         # Construct URL
         url = '/duration/positiveduration'
@@ -127,10 +133,13 @@ def get_positive_duration(
         Get a positive duration value
 
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: timedelta
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         # Construct URL
         url = '/duration/positiveduration'
@@ -172,10 +181,13 @@ def get_invalid(
         Get an invalid duration value
 
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: timedelta
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         # Construct URL
         url = '/duration/invalid'

diff --git a/...rouping/autorestparametergroupingtestservice/auto_rest_parameter_grouping_test_service.py b/...rouping/autorestparametergroupingtestservice/auto_rest_parameter_grouping_test_service.py
@@ -23,7 +23,8 @@ class AutoRestParameterGroupingTestServiceConfiguration(AzureConfiguration):
     attributes.
 
     :param credentials: Gets Azure subscription credentials.
-    :type credentials: credentials
+    :type credentials: :mod:`A msrestazure Credentials
+     object<msrestazure.azure_active_directory>`
     :param accept_language: Gets or sets the preferred language for the
      response.
     :type accept_language: str

diff --git a/...ceptanceTests/AzureParameterGrouping/autorestparametergroupingtestservice/models/error.py b/...ceptanceTests/AzureParameterGrouping/autorestparametergroupingtestservice/models/error.py
@@ -16,8 +16,10 @@
 class Error(Model):
     """Error
 
-    :param int status:
-    :param str message:
+    :param status:
+    :type status: int
+    :param message:
+    :type message: str
     """ 
 
     _attribute_map = {

diff --git a/...ureParameterGrouping/autorestparametergroupingtestservice/models/first_parameter_group.py b/...ureParameterGrouping/autorestparametergroupingtestservice/models/first_parameter_group.py
@@ -16,8 +16,10 @@ class FirstParameterGroup(Model):
     """
     Additional parameters for the postMultiParamGroups operation.
 
-    :param str header_one:
-    :param int query_one: Query parameter with default. Default value: 30 .
+    :param header_one:
+    :type header_one: str
+    :param query_one: Query parameter with default. Default value: 30 .
+    :type query_one: int
     """ 
 
     def __init__(self, header_one=None, query_one=30, **kwargs):

diff --git a/...oupingtestservice/models/parameter_grouping_post_multi_param_groups_second_param_group.py b/...oupingtestservice/models/parameter_grouping_post_multi_param_groups_second_param_group.py
@@ -16,8 +16,10 @@ class ParameterGroupingPostMultiParamGroupsSecondParamGroup(Model):
     """
     Additional parameters for the postMultiParamGroups operation.
 
-    :param str header_two:
-    :param int query_two: Query parameter with default. Default value: 30 .
+    :param header_two:
+    :type header_two: str
+    :param query_two: Query parameter with default. Default value: 30 .
+    :type query_two: int
     """ 
 
     def __init__(self, header_two=None, query_two=30, **kwargs):

diff --git a/...utorestparametergroupingtestservice/models/parameter_grouping_post_optional_parameters.py b/...utorestparametergroupingtestservice/models/parameter_grouping_post_optional_parameters.py
@@ -16,8 +16,10 @@ class ParameterGroupingPostOptionalParameters(Model):
     """
     Additional parameters for the postOptional operation.
 
-    :param str custom_header:
-    :param int query: Query parameter with default. Default value: 30 .
+    :param custom_header:
+    :type custom_header: str
+    :param query: Query parameter with default. Default value: 30 .
+    :type query: int
     """ 
 
     def __init__(self, custom_header=None, query=30, **kwargs):

diff --git a/...utorestparametergroupingtestservice/models/parameter_grouping_post_required_parameters.py b/...utorestparametergroupingtestservice/models/parameter_grouping_post_required_parameters.py
@@ -16,10 +16,14 @@ class ParameterGroupingPostRequiredParameters(Model):
     """
     Additional parameters for the postRequired operation.
 
-    :param int body:
-    :param str custom_header:
-    :param int query: Query parameter with default. Default value: 30 .
-    :param str path: Path parameter
+    :param body:
+    :type body: int
+    :param custom_header:
+    :type custom_header: str
+    :param query: Query parameter with default. Default value: 30 .
+    :type query: int
+    :param path: Path parameter
+    :type path: str
     """ 
 
     _validation = {

diff --git a/...Grouping/autorestparametergroupingtestservice/operations/parameter_grouping_operations.py b/...Grouping/autorestparametergroupingtestservice/operations/parameter_grouping_operations.py
@@ -40,12 +40,16 @@ def post_required(
         :param parameter_grouping_post_required_parameters: Additional
          parameters for the operation
         :type parameter_grouping_post_required_parameters:
-         ParameterGroupingPostRequiredParameters
+         :class:`ParameterGroupingPostRequiredParameters
+         <fixtures.acceptancetestsazureparametergrouping.models.ParameterGroupingPostRequiredParameters>`
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: None
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         body = None
         if parameter_grouping_post_required_parameters is not None:
@@ -107,12 +111,16 @@ def post_optional(
         :param parameter_grouping_post_optional_parameters: Additional
          parameters for the operation
         :type parameter_grouping_post_optional_parameters:
-         ParameterGroupingPostOptionalParameters
+         :class:`ParameterGroupingPostOptionalParameters
+         <fixtures.acceptancetestsazureparametergrouping.models.ParameterGroupingPostOptionalParameters>`
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: None
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         custom_header = None
         if parameter_grouping_post_optional_parameters is not None:
@@ -158,16 +166,21 @@ def post_multi_param_groups(
         Post parameters from multiple different parameter groups
 
         :param first_parameter_group: Additional parameters for the operation
-        :type first_parameter_group: FirstParameterGroup
+        :type first_parameter_group: :class:`FirstParameterGroup
+         <fixtures.acceptancetestsazureparametergrouping.models.FirstParameterGroup>`
         :param parameter_grouping_post_multi_param_groups_second_param_group:
          Additional parameters for the operation
         :type parameter_grouping_post_multi_param_groups_second_param_group:
-         ParameterGroupingPostMultiParamGroupsSecondParamGroup
+         :class:`ParameterGroupingPostMultiParamGroupsSecondParamGroup
+         <fixtures.acceptancetestsazureparametergrouping.models.ParameterGroupingPostMultiParamGroupsSecondParamGroup>`
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: None
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         header_one = None
         if first_parameter_group is not None:
@@ -223,12 +236,16 @@ def post_shared_parameter_group_object(
         Post parameters with a shared parameter group object
 
         :param first_parameter_group: Additional parameters for the operation
-        :type first_parameter_group: FirstParameterGroup
+        :type first_parameter_group: :class:`FirstParameterGroup
+         <fixtures.acceptancetestsazureparametergrouping.models.FirstParameterGroup>`
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: None
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         header_one = None
         if first_parameter_group is not None:

diff --git a/...anceTests/AzureReport/autorestreportserviceforazure/auto_rest_report_service_for_azure.py b/...anceTests/AzureReport/autorestreportserviceforazure/auto_rest_report_service_for_azure.py
@@ -24,7 +24,8 @@ class AutoRestReportServiceForAzureConfiguration(AzureConfiguration):
     attributes.
 
     :param credentials: Gets Azure subscription credentials.
-    :type credentials: credentials
+    :type credentials: :mod:`A msrestazure Credentials
+     object<msrestazure.azure_active_directory>`
     :param accept_language: Gets or sets the preferred language for the
      response.
     :type accept_language: str
@@ -81,10 +82,13 @@ def get_report(
         Get test coverage report
 
         :param dict custom_headers: headers that will be added to the request
-        :param boolean raw: returns the direct response alongside the
+        :param bool raw: returns the direct response alongside the
          deserialized response
+        :param operation_config: :ref:`Operation configuration
+         overrides<msrest:optionsforoperations>`.
         :rtype: dict
-        :rtype: msrest.pipeline.ClientRawResponse if raw=True
+        :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>`
+         if raw=true
         """
         # Construct URL
         url = '/report/azure'

diff --git a/....Tests/Expected/AcceptanceTests/AzureReport/autorestreportserviceforazure/models/error.py b/....Tests/Expected/AcceptanceTests/AzureReport/autorestreportserviceforazure/models/error.py
@@ -16,8 +16,10 @@
 class Error(Model):
     """Error
 
-    :param int status:
-    :param str message:
+    :param status:
+    :type status: int
+    :param message:
+    :type message: str
     """ 
 
     _attribute_map = {