chore(structure): add DocumentListBuilder.filter JSdoc details (#7402)

pedrobonamin · binoy14 · web-flow · commit 445384d41761 · 2024-08-21T14:39:51.000Z
* 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>
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 {

Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ export class DocumentListBuilder extends GenericListBuilder<`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`/** Set Document list filter`
`145`		`- * @param filter - filter`
	`145`	`+ * @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}`
`146`	`146`	`* @returns document list builder based on the options and filter provided. See {@link DocumentListBuilder}`
`147`	`147`	`*/`
`148`	`148`	`filter(filter: string): DocumentListBuilder {`