From 445384d41761f557b84e93f5720696dec9e9dc54 Mon Sep 17 00:00:00 2001 From: Pedro Bonamin <46196328+pedrobonamin@users.noreply.github.com> Date: Wed, 21 Aug 2024 16:39:51 +0200 Subject: [PATCH] chore(structure): add DocumentListBuilder.filter JSdoc details (#7402) * chore(structure): add DocumentListBuilder.filter JSdoc details * fix(structure): Use @link to create the doc link Co-authored-by: Binoy Patel --------- Co-authored-by: Binoy Patel --- packages/sanity/src/structure/structureBuilder/DocumentList.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/sanity/src/structure/structureBuilder/DocumentList.ts b/packages/sanity/src/structure/structureBuilder/DocumentList.ts index 598142d65c5..1c1ec3b4c8c 100644 --- a/packages/sanity/src/structure/structureBuilder/DocumentList.ts +++ b/packages/sanity/src/structure/structureBuilder/DocumentList.ts @@ -142,7 +142,7 @@ export class DocumentListBuilder extends GenericListBuilder< } /** Set Document list filter - * @param filter - filter + * @param filter - GROQ-filter used to determine which documents to display. Do not support joins, since they operate on individual documents, and will ignore order-clauses and projections. See {@link https://www.sanity.io/docs/realtime-updates} * @returns document list builder based on the options and filter provided. See {@link DocumentListBuilder} */ filter(filter: string): DocumentListBuilder {