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 <me@binoy.io> --------- Co-authored-by: Binoy Patel <me@binoy.io>
sanity-io · Aug 21, 2024 · 445384d · 445384d
1 parent c83021e
commit 445384d
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 {@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 {