chore(structure): add DocumentListBuilder.filter JSdoc details

sanity-io · Aug 21, 2024 · ccad32c · ccad32c
1 parent f53cd0e
commit ccad32c
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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 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 {