Fix multiple issues in README documentation#186
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR that tightens the README and Claude skill files: corrects dict-style relationship access to attribute access (matching the typed RelationshipInfo dataclass), clarifies that async snippets are fragments meant to be embedded in async def main(), expands authentication and exception-hierarchy guidance, and adds an alternate-key setup walkthrough plus minor query/bulk-update tweaks. Also fixes two operation docstring examples.
Changes:
- Replace
result['lookup_schema_name']/rel['SchemaName']/result['relationship_id']style access with.lookup_schema_name/.relationship_schema_name/.relationship_idattribute access throughout README and both SKILL.md copies. - Add async-fragment notes, alternate-key setup section,
len(results)count guidance,records.get()deprecation note, and a new exception-hierarchy/troubleshooting section. - Update authentication block with detailed
ClientSecretCredentialsetup comments and an Azure Identity reference link.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Major doc revisions: auth guidance, async fragment notes, alternate-key setup, attribute access on relationships, expanded exception hierarchy/troubleshooting (introduces httpx references and a credential mix-up in async Quick start). |
| .claude/skills/dataverse-sdk-use/SKILL.md | Mirrors README updates for relationship attribute access and async fragment notes. |
| src/PowerPlatform/Dataverse/claude_skill/dataverse-sdk-use/SKILL.md | Packaged copy of the same skill, kept in sync with the repo copy. |
| src/PowerPlatform/Dataverse/operations/tables.py | Fixes docstring example to use result.lookup_schema_name. |
| src/PowerPlatform/Dataverse/aio/operations/async_tables.py | Same docstring fix for the async variant. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sagebree
approved these changes
May 28, 2026
abelmilash-msft
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request significantly improves the documentation for the Dataverse Python SDK, focusing on clearer authentication setup, improved async usage guidance, enhanced exception handling documentation, and more accurate and idiomatic code examples. The changes help new and existing users better understand both basic and advanced SDK usage, error handling, and recommended best practices.
Authentication and credential setup:
ClientSecretCredentialandCertificateCredential, and emphasized the need to register an Azure AD application and configure permissions.Async client usage and documentation:
README.mdand.claude/skills/dataverse-sdk-use/SKILL.mdto clarify that async code fragments require anasync def main()context, and thatawaitcannot be used at the top level. [1] [2] [3] [4] [5] [6] [7]Exception handling and troubleshooting:
ValidationError,MetadataError,SQLParseError,HttpError, and network errors (httpx/aiohttp).continue_on_errorin batch operations only affects server-side failures, not client-side validation or metadata errors.Code correctness and idiomatic usage:
result.lookup_schema_name) instead of dictionary-style access, reflecting the actual SDK API and improving code reliability. [1] [2] [3] [4] [5]emailandcreditlimitinstead of deprecated or less common fields.Bulk and upsert operations:
exchangerate) and improved comments for clarity.These changes collectively make the documentation more accurate, user-friendly, and robust for both synchronous and asynchronous SDK usage.
References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21]