Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Aug 21, 2024
Merged

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

merged 2 commits into from
Aug 21, 2024

Conversation

pedrobonamin
Copy link
Contributor

@pedrobonamin pedrobonamin commented Aug 21, 2024 •
edited
Loading

Description

The JSdoc details for the DocumentListBuilder.filter don't provide enough information of how the filter works and what it supports.
This adds extra information and the reference to the realtime-updates docs

Once this is merged, will also update the docs in https://www.sanity.io/docs/structure-builder-reference#filter-c0dc69f8c387 to:
Screenshot 2024-08-21 at 10 29 16

Solves: #7399

What to review

Testing

n/a

Notes for release

n/a

@pedrobonamin pedrobonamin requested a review from a team as a code owner August 21, 2024 08:15
@pedrobonamin pedrobonamin requested review from binoy14 and removed request for a team August 21, 2024 08:15
@vercel Vercel
Copy link

vercel bot commented Aug 21, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
page-building-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:14pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:14pm
test-compiled-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:14pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:14pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:14pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Aug 21, 2024 2:14pm

@github-actions GitHub Actions
Copy link
Contributor

No changes to documentation

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 21, 2024 •
edited
Loading

Component Testing Report Updated Aug 21, 2024 2:33 PM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 46s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 8s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 31s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 38s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 19s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 11s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 3m 0s 0 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 46s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 51s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 16s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 9s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 26s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 18s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 1m 17s 21 0 0
formBuilder/tree-editing/TreeEditing.spec.tsx ✅ Passed (Inspect) 1m 51s 30 0 0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx ✅ Passed (Inspect) 20s 3 0 0

binoy14
binoy14 requested changes Aug 21, 2024
View reviewed changes
Copy link
Contributor

@binoy14 binoy14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes about how to create links.

Tip: You can run pnpm build && pnpm etl sanity && pnpm tsdoc:dev to test your changes locally. Need to re-run these commands on every change

packages/sanity/src/structure/structureBuilder/DocumentList.ts Outdated Show resolved Hide resolved
@pedrobonamin @binoy14
fix(structure): Use @link to create the doc link
e2ab9cb 
Co-authored-by: Binoy Patel <me@binoy.io>
binoy14
binoy14 approved these changes Aug 21, 2024
View reviewed changes
Copy link
Contributor

@binoy14 binoy14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks!

@pedrobonamin pedrobonamin added this pull request to the merge queue Aug 21, 2024
Merged via the queue into next with commit 445384d Aug 21, 2024
42 checks passed
@pedrobonamin pedrobonamin deleted the document-list-filter branch August 21, 2024 14:40
jordanl17 pushed a commit that referenced this pull request Aug 29, 2024
@pedrobonamin @binoy14 @jordanl17
chore(structure): add DocumentListBuilder.filter JSdoc details (#7402)
8be54ff 
* 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>
This was referenced Sep 20, 2024
Merged
Open
Open
Open
@mattobee mattobee mentioned this pull request Sep 25, 2024
Open
@mattobee mattobee mentioned this pull request Sep 25, 2024
Open
@samuelcastro samuelcastro mentioned this pull request Sep 27, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@binoy14 binoy14 binoy14 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pedrobonamin @binoy14