Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add core options ref #2555

Merged
merged 5 commits into from
Mar 31, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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