docstring updates

[zhaodongwang-msft]

Key updates:

• Removed descriptions from some init.py files since they are redundant
• Updated data type formats for standard types from str str because they display like this

- Updated descriptions for link classes like :class:`HttpClient` to :class:`~PowerPlatform.Dataverse.core.http.HttpClient` because they are displayed like - Added descriptions for modules that are missing them (auth.py etc.) - Updated the descriptions for OData functions since they are not in Sphinx-compatible format

This pull request focuses on improving documentation and code clarity for the Dataverse Python SDK. The main changes are the removal of the top-level package docstring, refinement of docstrings in the DataverseClient class to consistently use code formatting for types, and the addition of module-level docstrings for core modules. These updates enhance readability and make it easier for users and developers to understand the API and its usage.

Documentation improvements:

• Removed the detailed top-level package docstring from src/PowerPlatform/Dataverse/__init__.py to avoid redundancy and keep documentation focused within individual modules and classes.
• Added module-level docstrings to src/PowerPlatform/Dataverse/core/auth.py and src/PowerPlatform/Dataverse/core/config.py, describing their purpose and main classes provided. [1] [2]

Docstring and API clarity:

• Updated all parameter and return type annotations in DataverseClient methods to use code formatting (e.g., str instead of str), improving consistency and clarity in the documentation. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]
• Improved docstrings in TokenPair and AuthManager to use code formatting for type annotations and clarified the token acquisition process. [1] [2]
• Minor reformatting of docstring text for better readability and conciseness, such as combining sentences and clarifying notes. [1] [2] [3] [4]

These changes do not affect functionality but make the SDK easier to use and maintain.

[Copilot]

Pull Request Overview

This pull request improves documentation quality and consistency across the Dataverse Python SDK by standardizing docstring formatting, adding module-level docstrings, and removing redundant top-level package documentation.

• Updated all parameter and return type annotations to use code formatting (double backticks)
• Added module-level docstrings to core modules (auth, config, errors, odata)
• Simplified placeholder module docstrings (models, extensions, utils)

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/PowerPlatform/init.py	Removed namespace package docstring
src/PowerPlatform/Dataverse/init.py	Removed detailed top-level package docstring
src/PowerPlatform/Dataverse/client.py	Updated all docstring type annotations to use backticks
src/PowerPlatform/Dataverse/core/auth.py	Added module docstring and updated type formatting
src/PowerPlatform/Dataverse/core/config.py	Added module docstring and updated type formatting
src/PowerPlatform/Dataverse/core/errors.py	Added module docstring, updated type formatting, removed keyword-only marker
src/PowerPlatform/Dataverse/core/error_codes.py	Updated type formatting in docstrings
src/PowerPlatform/Dataverse/core/http.py	Updated module docstring and type formatting, removed keyword-only marker
src/PowerPlatform/Dataverse/data/odata.py	Added module docstring, updated extensive docstrings with consistent formatting
src/PowerPlatform/Dataverse/data/upload.py	Simplified module and class docstrings, updated type formatting
src/PowerPlatform/Dataverse/models/init.py	Simplified placeholder docstring
src/PowerPlatform/Dataverse/extensions/init.py	Simplified placeholder docstring
src/PowerPlatform/Dataverse/utils/init.py	Simplified module docstring
src/PowerPlatform/Dataverse/utils/pandas_adapter.py	Updated module and parameter type formatting

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.