From e6c017e43d57454ddfa7182a8c672bd87faa944c Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Thu, 11 Mar 2021 10:04:11 -0800 Subject: [PATCH 1/5] add core options ref --- docs/python/documentation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/python/documentation.md b/docs/python/documentation.md index 2f6b7322941..431dfd8c391 100644 --- a/docs/python/documentation.md +++ b/docs/python/documentation.md @@ -35,6 +35,8 @@ As you write your code, *doc it so you never hear about it again.* The less ques {% include requirement/MUST id="python-docstrings-kwargs" %} document any `**kwargs` directly consumed by a method. You may refer to the signature of a called method if the `**kwargs` are passed through. +{% include requirement/MUST id="python-docstrings-kwargs" %} add a ref link to [core options](https://aka.ms/azsdk/python/options) to provide introduction for shared options. + Example: ```python def request(method, url, headers, **kwargs): ... From 0fe314e3b36384ad50592bc8704daf0be776bfcb Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Thu, 11 Mar 2021 10:07:47 -0800 Subject: [PATCH 2/5] update --- docs/python/documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/python/documentation.md b/docs/python/documentation.md index 431dfd8c391..0fc838e1298 100644 --- a/docs/python/documentation.md +++ b/docs/python/documentation.md @@ -35,7 +35,7 @@ As you write your code, *doc it so you never hear about it again.* The less ques {% include requirement/MUST id="python-docstrings-kwargs" %} document any `**kwargs` directly consumed by a method. You may refer to the signature of a called method if the `**kwargs` are passed through. -{% include requirement/MUST id="python-docstrings-kwargs" %} add a ref link to [core options](https://aka.ms/azsdk/python/options) to provide introduction for shared options. +{% include requirement/MUST id="python-docstrings-kwargs" %} add a ref link to [core options](https://aka.ms/azsdk/python/options) to provide introduction for shared options if they are supported in the method. Example: ```python From f5f9602837f37bf9ca73b30e90d60c01dc32f037 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Wed, 24 Mar 2021 13:26:39 -0700 Subject: [PATCH 3/5] add snippet --- docs/python/documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/python/documentation.md b/docs/python/documentation.md index 0fc838e1298..ce573bcb196 100644 --- a/docs/python/documentation.md +++ b/docs/python/documentation.md @@ -35,7 +35,7 @@ As you write your code, *doc it so you never hear about it again.* The less ques {% include requirement/MUST id="python-docstrings-kwargs" %} document any `**kwargs` directly consumed by a method. You may refer to the signature of a called method if the `**kwargs` are passed through. -{% include requirement/MUST id="python-docstrings-kwargs" %} add a ref link to [core options](https://aka.ms/azsdk/python/options) to provide introduction for shared options if they are supported in the method. +{% include requirement/MUST id="python-docstrings-kwargs" %} add a ref link to [core options](https://aka.ms/azsdk/python/options) to provide introduction for shared options if they are supported in the method. e.g. For more options see [core options](https://aka.ms/azsdk/python/options). Example: ```python From 8e5c374145f514a88d8a39767d8471111f8e3274 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Thu, 25 Mar 2021 09:38:41 -0700 Subject: [PATCH 4/5] update doc --- docs/python/documentation.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/python/documentation.md b/docs/python/documentation.md index ce573bcb196..716654b966d 100644 --- a/docs/python/documentation.md +++ b/docs/python/documentation.md @@ -33,16 +33,20 @@ As you write your code, *doc it so you never hear about it again.* The less ques {% include requirement/MUST id="python-docstrings-all" %} provide docstrings for all public modules, types, and methods. -{% include requirement/MUST id="python-docstrings-kwargs" %} document any `**kwargs` directly consumed by a method. You may refer to the signature of a called method if the `**kwargs` are passed through. - -{% include requirement/MUST id="python-docstrings-kwargs" %} add a ref link to [core options](https://aka.ms/azsdk/python/options) to provide introduction for shared options if they are supported in the method. e.g. For more options see [core options](https://aka.ms/azsdk/python/options). +{% include requirement/MUST id="python-docstrings-kwargs" %} document any `**kwargs` directly consumed by a method and add a ref link to [core options](https://aka.ms/azsdk/python/options) to provide introduction for shared options. You may refer to the signature of a called method if the `**kwargs` are passed through. Example: ```python def request(method, url, headers, **kwargs): ... def get(*args, **kwargs): - "Calls `request` with the method "GET" and forwards all other arguments." + """Calls `request` with the method "GET" and forwards all other arguments. + + :param str method-param: The method-param parameter + :keyword int method-kwarg: The optional method-kwarg parameter + + For additional request configuration options, please see [core options](https://aka.ms/azsdk/python/options). + """ return request("GET", *args, **kwargs) ``` From 68cdfb85388127c7b990d409ebd8bd11e0aaef42 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Mon, 29 Mar 2021 16:05:16 -0700 Subject: [PATCH 5/5] update --- docs/python/documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/python/documentation.md b/docs/python/documentation.md index 716654b966d..7bc50417d7b 100644 --- a/docs/python/documentation.md +++ b/docs/python/documentation.md @@ -45,7 +45,7 @@ def get(*args, **kwargs): :param str method-param: The method-param parameter :keyword int method-kwarg: The optional method-kwarg parameter - For additional request configuration options, please see [core options](https://aka.ms/azsdk/python/options). + For additional request configuration options, please see https://aka.ms/azsdk/python/options. """ return request("GET", *args, **kwargs) ```