Skip to content

Commit 20311f6

Browse files
Abel Milashclaude
andcommitted
Fix remaining docfx warnings in query_builder docstrings
Change :meth: cross-references to plain backtick formatting for the 'build' method. The doc tool was failing to resolve :meth:`build` and :meth:`QueryBuilder.build` because 'build' is defined on the private '_QueryBuilderBase' parent class — autoapi/docfx can't link to private classes. Plain backticks (``build()``) render the same in HTML but skip cross-reference resolution. Expected impact on Microsoft Learn doc build: 3 warnings -> 0 or 1 (the only potentially remaining warning is the auto-generated 'inherits from _QueryBuilderBase' reference in QueryBuilder's page, which can only be eliminated by renaming the private class). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 034828f commit 20311f6

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/PowerPlatform/Dataverse/models/query_builder.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474

7575

7676
class QueryParams(TypedDict, total=False):
77-
"""Typed dictionary returned by :meth:`QueryBuilder.build`.
77+
"""Typed dictionary returned by ``QueryBuilder.build()``.
7878
7979
Provides IDE autocomplete when passing build results to
8080
``client.records.list()`` manually.
@@ -187,7 +187,7 @@ class _QueryBuilderBase:
187187
Holds all query state and chaining methods (``select``, ``where``,
188188
``order_by``, ``top``, ``page_size``, ``count``, ``expand``,
189189
``include_annotations``, ``include_formatted_values``) and
190-
:meth:`build`.
190+
``build()``.
191191
192192
Subclasses add execution: :class:`QueryBuilder` for sync clients,
193193
:class:`~PowerPlatform.Dataverse.aio.models.async_query_builder.AsyncQueryBuilder`
@@ -451,7 +451,7 @@ class QueryBuilder(_QueryBuilderBase):
451451
"""Fluent interface for building and executing OData queries against a sync client.
452452
453453
Provides method chaining for constructing complex queries with
454-
composable filter expressions. Can be used standalone (via :meth:`build`)
454+
composable filter expressions. Can be used standalone (via ``build()``)
455455
or bound to a client (via :meth:`execute`).
456456
457457
:param table: Table schema name to query.
@@ -483,7 +483,7 @@ def execute(self, *, by_page=_BY_PAGE_UNSET) -> Union[QueryResult, Iterator[Quer
483483
484484
This method is only available when the QueryBuilder was created
485485
via ``client.query.builder(table)``. Standalone ``QueryBuilder``
486-
instances should use :meth:`build` to get parameters and pass them
486+
instances should use ``build()`` to get parameters and pass them
487487
to ``client.records.list()`` manually.
488488
489489
At least one of ``select()``, ``where()``, or ``top()`` must be

0 commit comments

Comments
 (0)