Skip to content

[Doc] update doc for resolve_issues_effectively #24642

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.

Sign up for GitHub

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

Merged
BigCat20196 merged 12 commits into from
Jun 6, 2022
Merged

[Doc] update doc for resolve_issues_effectively #24642

Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1151719
create doc
BigCat20196 May 24, 2022
3232a62
remove to the folder
BigCat20196 May 27, 2022
87b112f
remove to the folder
BigCat20196 May 27, 2022
ad909e3
add common error soluation
BigCat20196 May 30, 2022
a7b16a6
fix
BigCat20196 May 30, 2022
cfc4097
Update resolve_issues_effectively.md
BigCat20196 May 30, 2022
2091c11
Update doc/dev/issues/resolve_issues_effectively.md
msyyc May 31, 2022
074e1ab
Update doc/dev/issues/resolve_issues_effectively.md
msyyc May 31, 2022
921bc85
Update doc/dev/issues/resolve_issues_effectively.md
BigCat20196 May 31, 2022
c7934e4
Update doc/dev/issues/resolve_issues_effectively.md
BigCat20196 May 31, 2022
78b73f7
update doc
BigCat20196 May 31, 2022
faf4198
Update resolve_issues_effectively.md
BigCat20196 Jun 2, 2022
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
23 changes: 22 additions & 1 deletion doc/dev/issues/resolve_issues_effectively.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Most issues can be classified into 3 categories. They are
## Usage error (For users)
If you are not familiar with the SDK usage of a service, you can find relevant examples in [this repo][sample repo] in most cases.

For some common errors, you can check [here](##Summary Of Common Errors).
Comment thread
msyyc marked this conversation as resolved.
Outdated

## Feature Request(For users)

See [here][request_a_feature] for more details.
Expand All @@ -23,6 +25,23 @@ If you can provide detailed reproduction steps, it will help us locate and solve

<hr/>

## Summary Of Common Errors

### Error from Track1 to Track2
If the code you use needs to set wait() function for the Long Running Operation to wait for the result, it should be the SDK of Track1. We have stopped maintenance at present.

We strongly recommend that you update the SDK version. Then you will find that in the SDK of Track2, we all use the function name prefixed with `begin_` for LRO operations, and the result() method can be used to get the returned result.
Comment thread
BigCat20196 marked this conversation as resolved.

### Error from Service
Comment thread
BigCat20196 marked this conversation as resolved.
Outdated
Since the python SDK is generated based on the [rest API][rest API], it will not deliberately change the returned results. So if you have any questions about the response result value of the request, please open the issue under the [rest issue][rest issue].
Comment thread
BigCat20196 marked this conversation as resolved.
Outdated

### Error like (AttributeError: 'PipelineResponse' object has no attribute 'get')
When this error occurs, you can check the version of `msrest`. Currently, for most SDKs, it needs to be >= 0.6.21. FYI: [SDK dependency][SDK dependency]

You could upgrade the dependency before using the SDK to check if the issue has been solved.
Comment thread
BigCat20196 marked this conversation as resolved.
Outdated

<hr/>

Comment thread
BigCat20196 marked this conversation as resolved.
## Resolve issue (For contributors)

Bug report is one of the most common issues reported in open-source community. Basic steps to resolve a bug report are
Expand Down Expand Up @@ -56,4 +75,6 @@ If the issue is not from the SDK but from the [rest API][rest API], you can repl

[sample repo]: https://github.com/Azure-Samples/azure-samples-python-management
[request_a_feature]: https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/how_to_request_a_feature_in_sdk.md
[rest API]: https://github.com/Azure/azure-rest-api-specs
[rest API]: https://github.com/Azure/azure-rest-api-specs
[rest issue]: https://github.com/Azure/azure-rest-api-specs/issues
[SDK dependency]: https://github.com/Azure/azure-sdk-for-python/blob/main/shared_requirements.txt