diff --git a/docs/python/documentation.md b/docs/python/documentation.md index 2f6b7322941..7bc50417d7b 100644 --- a/docs/python/documentation.md +++ b/docs/python/documentation.md @@ -33,14 +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" %} 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 https://aka.ms/azsdk/python/options. + """ return request("GET", *args, **kwargs) ```