Skip to content

Commit

Permalink
add core options ref (#2555)
Browse files Browse the repository at this point in the history
* add core options ref
  • Loading branch information
xiangyan99 authored Mar 31, 2021
1 parent f6d0841 commit 40a10a2
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/python/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```

Expand Down

0 comments on commit 40a10a2

Please sign in to comment.