Skip to content

Commit

Permalink
[Doc] update doc for resolve_issues_effectively (Azure#24642)
Browse files Browse the repository at this point in the history
* create doc

* remove to the folder

* Update resolve_issues_effectively.md

Co-authored-by: Yuchao Yan <[email protected]>
  • Loading branch information
2 people authored and sarkar-rajarshi committed Jun 9, 2022
1 parent 62414e4 commit 4abea51
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion doc/dev/issues/resolve_issues_effectively.md
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).

## Feature Request(For users)

See [here][request_a_feature] for more details.
Expand All @@ -23,6 +25,19 @@ 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.
(More Details: [guidance][guidance])

### Possible Error from Service
Since the python SDK is generated based on the [rest API][rest API], it will not deliberately change the returned results. So if you think the returned result is not as expected, please open the issue under the [rest issue][rest issue].

<hr/>

## 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 @@ -53,7 +68,13 @@ Once you have confirmed the bug and found the fault location, it should be easy

If the issue is not from the SDK but from the [rest API][rest API], you can reply to the user and reopen the issue in the appropriate place.

### Error like (AttributeError: 'PipelineResponse' object has no attribute 'get')
When this error occurs, you can check the version of `msrest` and upgrade it to latest version then try again.


[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
[guidance]: https://devblogs.microsoft.com/azure-sdk/migrating-python-management-libraries/

0 comments on commit 4abea51

Please sign in to comment.