Skip to content

You should update that readme file. There are lots of typos and errors in it. #15446

@BillmanH

Description

@BillmanH
  • Package Name: any
  • Package Version: any
  • Operating System:any
  • Python Version: any

Describe the bug
There are a lot of typos in this doc and it is difficult to get through. https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/digitaltwins/azure-digitaltwins-core

Here are the things I have noticed so far:

  • MSFT is aware of a typo in the code and is apparently considering potential fixes.
  • You do not have to load the client secret into your environment variables. Skip all that and use the AzureCliCredential if you are developing locally and not building an app.
  • There are no import statements in the code examples. You will have to figure out where those methods are on your own. Some things are from other packages such as json and uuid.
  • serviceClient and service_client are used interchangably as well as some other naming issues.
  • The doc references the query language that is at review.docs (and inaccesible to non MSFT employees), Here is the public doc.

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

Metadata

Metadata

Labels

ClientThis issue points to a problem in the data-plane of the library.Digital Twinscustomer-reportedIssues that are reported by GitHub users external to the Azure organization.questionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions