Fix Sphinx cross-references in docstrings

Cleans up ~17 doc-build warnings caused by short-form, wrong-path,
or unresolvable references in docstrings:

- operations/records.py: qualify :class:`QueryResult` and :class:`FilterExpression`
- operations/batch.py: qualify :attr:`BatchResult.responses` and :class:`FilterExpression`;
  replace unresolvable :attr: refs to instance attributes with plain backticks
- operations/tables.py: fully qualify :attr:`AlternateKeyInfo.status`
- models/fetchxml_query.py: correct wrong path (models.fetchxml_query.QueryResult
  → models.record.QueryResult)
- core/log_config.py: qualify :class:`LogConfig` self-reference
- client.py: replace reference to private _ODataClient with plain text

Combined with the empty __all__ change, expected to reduce Microsoft
Learn doc-build warnings from 38 to ~4 (the remaining 4 are auto-generated
:mod: references to models.record in toc.yml that need a doc-repo-side fix).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: Abel Milash

src/PowerPlatform/Dataverse/client.py

@@ -27,7 +27,7 @@ class DataverseClient:
 
     This client provides a simple, stable interface for interacting with Dataverse environments
     through the Web API. It handles authentication via Azure Identity and delegates HTTP operations
-    to an internal :class:`~PowerPlatform.Dataverse.data._odata._ODataClient`.
+    to an internal OData client.
 
     Key capabilities:
         - OData CRUD operations: create, read, update, delete records

src/PowerPlatform/Dataverse/core/log_config.py

@@ -4,7 +4,7 @@
 """
 Local file logging configuration for Dataverse SDK HTTP diagnostics.
 
-Provides :class:`LogConfig`, an opt-in configuration for writing request/response
+Provides :class:`~PowerPlatform.Dataverse.core.log_config.LogConfig`, an opt-in configuration for writing request/response
 traces to ``.log`` files with automatic header redaction and timestamped filenames.
 """
 

src/PowerPlatform/Dataverse/models/fetchxml_query.py

@@ -52,7 +52,7 @@ def __init__(self, xml: str, entity_name: str, client: "DataverseClient") -> Non
         self._client = client
 
     def execute(self) -> QueryResult:
-        """Execute the FetchXML query and return all results as a :class:`QueryResult`.
+        """Execute the FetchXML query and return all results as a :class:`~PowerPlatform.Dataverse.models.record.QueryResult`.
 
         Blocking — fetches all pages upfront and holds every record in memory before
         returning. Simple for small-to-medium result sets; use :meth:`execute_pages`
@@ -72,7 +72,7 @@ def execute(self) -> QueryResult:
         return QueryResult(all_records)
 
     def execute_pages(self) -> Iterator[QueryResult]:
-        """Lazily yield one :class:`QueryResult` per HTTP page.
+        """Lazily yield one :class:`~PowerPlatform.Dataverse.models.record.QueryResult` per HTTP page.
 
         Streaming — each iteration fires one HTTP request and yields one page.
         Prefer over :meth:`execute` when:
@@ -84,7 +84,7 @@ def execute_pages(self) -> Iterator[QueryResult]:
 
         One-shot — do not iterate more than once.
 
-        :return: Iterator of per-page :class:`QueryResult` objects.
+        :return: Iterator of per-page :class:`~PowerPlatform.Dataverse.models.record.QueryResult` objects.
         :rtype: Iterator[:class:`~PowerPlatform.Dataverse.models.record.QueryResult`]
 
         Example::

src/PowerPlatform/Dataverse/operations/batch.py

@@ -72,7 +72,7 @@ class ChangeSetRecordOperations:
     create/update/delete). Only write operations are allowed — GET is not
     permitted inside a changeset.
 
-    Do not instantiate directly; use :attr:`ChangeSet.records`.
+    Do not instantiate directly; use ``ChangeSet.records``.
     """
 
     def __init__(self, cs_internal: _ChangeSet) -> None:
@@ -136,7 +136,7 @@ class ChangeSet:
     A transactional group of single-record write operations.
 
     All operations succeed or are rolled back together. Use as a context
-    manager or call :attr:`records` to add operations directly.
+    manager or call ``records`` to add operations directly.
 
     Do not instantiate directly; use :meth:`BatchRequest.changeset`.
 
@@ -412,7 +412,7 @@ def list(
 
         :param table: Table schema name (e.g. ``"account"``).
         :type table: :class:`str`
-        :param filter: Optional OData ``$filter`` expression or :class:`FilterExpression`.
+        :param filter: Optional OData ``$filter`` expression or :class:`~PowerPlatform.Dataverse.models.filters.FilterExpression`.
         :type filter: str or FilterExpression or None
         :param select: Optional list of column logical names to include.
         :type select: list[str] or None
@@ -574,7 +574,7 @@ def add_columns(self, table: str, columns: Dict[str, Any]) -> None:
         Add column-create operations to the batch (one per column).
 
         The table's ``MetadataId`` is resolved at execute time. Each column
-        produces one entry in :attr:`BatchResult.responses`.
+        produces one entry in :attr:`~PowerPlatform.Dataverse.models.batch.BatchResult.responses`.
 
         :param table: Schema name of the target table.
         :type table: :class:`str`
@@ -589,7 +589,7 @@ def remove_columns(self, table: str, columns: Union[str, List[str]]) -> None:
 
         The table's ``MetadataId`` and each column's ``MetadataId`` are resolved
         at execute time. Each column produces one entry in
-        :attr:`BatchResult.responses`.
+        :attr:`~PowerPlatform.Dataverse.models.batch.BatchResult.responses`.
 
         :param table: Schema name of the target table.
         :type table: :class:`str`
@@ -926,7 +926,7 @@ class BatchRequest:
     Builder for constructing and executing a Dataverse OData ``$batch`` request.
 
     Obtain via :meth:`BatchOperations.new` (``client.batch.new()``). Add operations
-    through :attr:`records`, :attr:`tables`, :attr:`query`, and :attr:`dataframe`,
+    through ``records``, ``tables``, ``query``, and ``dataframe``,
     optionally group writes
     into a :meth:`changeset`, then call :meth:`execute`.
 

src/PowerPlatform/Dataverse/operations/records.py

@@ -548,14 +548,14 @@ def list(
         count: bool = False,
         include_annotations: Optional[str] = None,
     ) -> QueryResult:
-        """Fetch multiple records and return them as a :class:`QueryResult`.
+        """Fetch multiple records and return them as a :class:`~PowerPlatform.Dataverse.models.record.QueryResult`.
 
         GA replacement for ``records.get(table, filter=...)``. All pages are
-        collected eagerly and returned as a single :class:`QueryResult`.
+        collected eagerly and returned as a single :class:`~PowerPlatform.Dataverse.models.record.QueryResult`.
 
         :param table: Schema name of the table (e.g. ``"account"``).
         :type table: :class:`str`
-        :param filter: Optional OData filter string or :class:`FilterExpression`.
+        :param filter: Optional OData filter string or :class:`~PowerPlatform.Dataverse.models.filters.FilterExpression`.
         :type filter: str or FilterExpression or None
         :param select: Optional list of column logical names to include.
         :type select: list[str] or None
@@ -572,7 +572,7 @@ def list(
         :param include_annotations: OData annotation pattern for the
             ``Prefer: odata.include-annotations`` header, or ``None``.
         :type include_annotations: :class:`str` or None
-        :return: All matching records collected into a :class:`QueryResult`.
+        :return: All matching records collected into a :class:`~PowerPlatform.Dataverse.models.record.QueryResult`.
         :rtype: :class:`~PowerPlatform.Dataverse.models.record.QueryResult`
 
         Example::
@@ -622,15 +622,15 @@ def list_pages(
         count: bool = False,
         include_annotations: Optional[str] = None,
     ) -> Iterator[QueryResult]:
-        """Lazily yield one :class:`QueryResult` per HTTP page.
+        """Lazily yield one :class:`~PowerPlatform.Dataverse.models.record.QueryResult` per HTTP page.
 
         Streaming counterpart to :meth:`list`. Each iteration triggers one
         network request via ``@odata.nextLink``. One-shot — do not iterate
         more than once.
 
         :param table: Schema name of the table (e.g. ``"account"``).
         :type table: :class:`str`
-        :param filter: Optional OData filter string or :class:`FilterExpression`.
+        :param filter: Optional OData filter string or :class:`~PowerPlatform.Dataverse.models.filters.FilterExpression`.
         :type filter: str or FilterExpression or None
         :param select: Optional list of column logical names to include.
         :type select: list[str] or None
@@ -647,7 +647,7 @@ def list_pages(
         :param include_annotations: OData annotation pattern for the
             ``Prefer: odata.include-annotations`` header, or ``None``.
         :type include_annotations: :class:`str` or None
-        :return: Iterator of per-page :class:`QueryResult` objects.
+        :return: Iterator of per-page :class:`~PowerPlatform.Dataverse.models.record.QueryResult` objects.
         :rtype: Iterator[:class:`~PowerPlatform.Dataverse.models.record.QueryResult`]
 
         Example::

src/PowerPlatform/Dataverse/operations/tables.py

@@ -593,7 +593,7 @@ def create_alternate_key(
 
         Alternate keys allow upsert operations to identify records by one or
         more columns instead of the primary GUID. After creation the key is
-        queued for index building; its :attr:`~AlternateKeyInfo.status` will
+        queued for index building; its :attr:`~PowerPlatform.Dataverse.models.table_info.AlternateKeyInfo.status` will
         transition from ``"Pending"`` to ``"Active"`` once the index is ready.
 
         :param table: Schema name of the table (e.g. ``"new_Product"``).