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.

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

doc(sanity): add TS-doc for block content related types #4674

Merged
merged 4 commits into from
Oct 16, 2023

Conversation

skogsmaskin
Copy link
Member

@skogsmaskin skogsmaskin commented Jul 7, 2023

Description

This will add ts-doc to the most used block-content related types in the sanity package.

What to review

  • That the copy is ok
  • That the deprecation is ok
  • That the related dependent interfaces that are made @public here is actually made public and documented elsewhere.

Notes for release

N/A

@vercel
Copy link

vercel bot commented Jul 7, 2023

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

Name Status Preview Comments Updated (UTC)
performance-studio ✅ Ready (Inspect) Visit Preview Oct 9, 2023 11:14am
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 9, 2023 11:14am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Oct 9, 2023 11:14am

@skogsmaskin skogsmaskin changed the title doc: WIP - add tsdoc comments to block related things in the 'sanity'… Add tsdoc comments to Portable Text related things in 'sanity' package Jul 7, 2023
@rexxars rexxars requested review from binoy14 and RitaDias August 17, 2023 16:16
@rexxars
Copy link
Member

rexxars commented Aug 17, 2023

Is this ready for review, @skogsmaskin or does it still need work?

@skogsmaskin
Copy link
Member Author

Is this ready for review, @skogsmaskin or does it still need work?

I have some stuff locally that I will commit tomorrow that makes this PR ready for review.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 2023

Component Testing Report Updated Oct 9, 2023 11:16 AM (UTC)

File Status Duration Passed Skipped Failed
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 7s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 11s 3 0 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 12s 6 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 16s 9 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 55s 18 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 12s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 7s 3 0 0

@skogsmaskin skogsmaskin changed the title Add tsdoc comments to Portable Text related things in 'sanity' package Add tsdoc comments to block content types 'sanity' package Sep 13, 2023
@skogsmaskin skogsmaskin changed the title Add tsdoc comments to block content types 'sanity' package doc(sanity): add TS-doc for block content related types Sep 13, 2023
@skogsmaskin skogsmaskin marked this pull request as ready for review September 13, 2023 13:16
@github-actions
Copy link
Contributor

github-actions bot commented Sep 13, 2023

Package Documentation Change
@sanity/types +16%
sanity +9%
Full Report
@sanity/types
This branch Next branch
53 documented 46 documented
233 not documented 240 not documented
sanity
This branch Next branch
119 documented 110 documented
824 not documented 834 not documented
@sanity/diff
This branch Next branch
13 documented 13 documented
16 not documented 16 not documented
@sanity/block-tools
This branch Next branch
4 documented 4 documented
9 not documented 9 not documented
sanity/desk
This branch Next branch
83 documented 83 documented
55 not documented 55 not documented
@sanity/portable-text-editor
This branch Next branch
21 documented 21 documented
44 not documented 44 not documented
@sanity/mutator
This branch Next branch
7 documented 7 documented
4 not documented 4 not documented
@sanity/cli
This branch Next branch
1 documented 1 documented
30 not documented 30 not documented
@sanity/schema/_internal
This branch Next branch
0 documented 0 documented
9 not documented 9 not documented
@sanity/util/paths
This branch Next branch
1 documented 1 documented
15 not documented 15 not documented
sanity/router
This branch Next branch
15 documented 15 documented
21 not documented 21 not documented
@sanity/util/legacyDateFormat
This branch Next branch
0 documented 0 documented
3 not documented 3 not documented
@sanity/schema
This branch Next branch
0 documented 0 documented
2 not documented 2 not documented
sanity/cli
This branch Next branch
2 documented 2 documented
0 not documented 0 not documented
@sanity/vision
This branch Next branch
0 documented 0 documented
2 not documented 2 not documented
@sanity/util/fs
This branch Next branch
0 documented 0 documented
3 not documented 3 not documented
sanity/_internal
This branch Next branch
0 documented 0 documented
1 not documented 1 not documented
@sanity/util/content
This branch Next branch
1 documented 1 documented
5 not documented 5 not documented

Copy link
Member

@bjoerge bjoerge left a comment

Choose a reason for hiding this comment

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

This looks great. Thank you for taking the time to do this, @skogsmaskin <3

@skogsmaskin skogsmaskin added this pull request to the merge queue Oct 16, 2023
Merged via the queue into next with commit c363e8b Oct 16, 2023
14 checks passed
@skogsmaskin skogsmaskin deleted the feat/pt-tsdoc branch October 16, 2023 14:50
rexxars pushed a commit that referenced this pull request Oct 17, 2023
* chore(core/form/inputs): remove outdated workshop case

Remove this non-working workshop left over from v2

* refactor(core/form/inputs): deprecate block marker callbacks and support

* doc(types): add ts doc comments to block schema types

* doc(sanity): add TS-doc for block content related types
binoy14 pushed a commit that referenced this pull request Oct 18, 2023
* chore(core/form/inputs): remove outdated workshop case

Remove this non-working workshop left over from v2

* refactor(core/form/inputs): deprecate block marker callbacks and support

* doc(types): add ts doc comments to block schema types

* doc(sanity): add TS-doc for block content related types
github-merge-queue bot pushed a commit that referenced this pull request Oct 20, 2023
#5002)

* doc(sanity): add TS-doc for block content related types (#4674)

* chore(core/form/inputs): remove outdated workshop case

Remove this non-working workshop left over from v2

* refactor(core/form/inputs): deprecate block marker callbacks and support

* doc(types): add ts doc comments to block schema types

* doc(sanity): add TS-doc for block content related types

* fix(login): fix issue where logo is not shown on custom auth providers

---------

Co-authored-by: Per-Kristian Nordnes <[email protected]>
rexxars pushed a commit that referenced this pull request Oct 20, 2023
* chore(core/form/inputs): remove outdated workshop case

Remove this non-working workshop left over from v2

* refactor(core/form/inputs): deprecate block marker callbacks and support

* doc(types): add ts doc comments to block schema types

* doc(sanity): add TS-doc for block content related types
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants