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

docs(suspensive.org): add docs for shouldCatch at ErrorBoundary #1085

Merged
merged 5 commits into from
Jul 14, 2024

Conversation

jgjgill
Copy link
Contributor

@jgjgill jgjgill commented Jul 14, 2024

Overview

close #952

Hi, I worked on the docs. 🧐
This is my first time adding docs to this library.
So please feel free to tell me if I'm missing anything.

Thanks for the opportunity. πŸ™‡β€β™‚οΈ

PR Checklist

  • I did below actions if need
  1. I read the Contributing Guide
  2. I added documents and tests.

@jgjgill jgjgill requested a review from manudeli as a code owner July 14, 2024 10:55
Copy link

changeset-bot bot commented Jul 14, 2024

πŸ¦‹ Changeset detected

Latest commit: d8bd14c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@suspensive/react Patch
@suspensive/react-query-4 Patch
@suspensive/react-query-5 Patch
@suspensive/react-query Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Jul 14, 2024

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
suspensive.org βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Jul 14, 2024 4:37pm
v1.suspensive.org βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Jul 14, 2024 4:37pm
visualization.suspensive.org βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Jul 14, 2024 4:37pm

Copy link

vercel bot commented Jul 14, 2024

@jgjgill is attempting to deploy a commit to the Toss Team on Vercel.

A member of the Team first needs to authorize it.

@codecov-commenter
Copy link

codecov-commenter commented Jul 14, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 84.23%. Comparing base (02f0aec) to head (d8bd14c).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1085   +/-   ##
=======================================
  Coverage   84.23%   84.23%           
=======================================
  Files          54       54           
  Lines         552      552           
  Branches      117      118    +1     
=======================================
  Hits          465      465           
  Misses         82       82           
  Partials        5        5           
Components Coverage Ξ”
@suspensive/react 97.05% <ΓΈ> (ΓΈ)
@suspensive/react-query 75.28% <ΓΈ> (ΓΈ)
@suspensive/react-query-4 0.00% <ΓΈ> (ΓΈ)
@suspensive/react-query-5 0.00% <ΓΈ> (ΓΈ)
@suspensive/jotai 0.00% <ΓΈ> (ΓΈ)
@suspensive/cache 100.00% <ΓΈ> (ΓΈ)
@suspensive/react-await 100.00% <ΓΈ> (ΓΈ)
@suspensive/react-image 80.39% <ΓΈ> (ΓΈ)

Copy link

codspeed-hq bot commented Jul 14, 2024

CodSpeed Performance Report

Merging #1085 will create unknown performance changes

Comparing jgjgill:docs/errorBoundary-shouldCatch (d8bd14c) with main (02f0aec)

Summary

⚠️ No benchmarks were detected in both the base of the PR and the PR.

Copy link
Member

@manudeli manudeli left a comment

Choose a reason for hiding this comment

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

@jgjgill Thanks!! You made cool example too!
I left comments to improve some things

@jgjgill
Copy link
Contributor Author

jgjgill commented Jul 14, 2024

@manudeli
Thank you for your quick feedback.
I've reflected review. πŸ™‡β€β™‚οΈ

@jgjgill jgjgill requested a review from manudeli July 14, 2024 15:31
Copy link
Member

@manudeli manudeli left a comment

Choose a reason for hiding this comment

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

Thank you for contributing to making this library easier! I'm glad that library users can now better understand and use the shouldCatch prop. πŸš€

@manudeli manudeli merged commit 6848e8d into toss:main Jul 14, 2024
14 checks passed
manudeli pushed a commit that referenced this pull request Jul 14, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @suspensive/react@2.6.2

### Patch Changes

- [#1085](#1085)
[`6848e8d`](6848e8d)
Thanks [@jgjgill](https://github.com/jgjgill)! - fix(react): add jsdoc
for shouldCatch prop of ErrorBoundary

## @suspensive/react-query@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
    -   @suspensive/react-query-4@2.6.2
    -   @suspensive/react-query-5@2.6.2

## @suspensive/react-query-4@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2

## @suspensive/react-query-5@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
manudeli added a commit that referenced this pull request Aug 3, 2024
)

# Overview

close #952 

Hi, I worked on the docs. 🧐
This is my first time adding docs to this library.
So please feel free to tell me if I'm missing anything.

Thanks for the opportunity. πŸ™‡β€β™‚οΈ

<!--
    A clear and concise description of what this pr is about.
 -->

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
manudeli added a commit that referenced this pull request Aug 3, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @suspensive/react@2.6.2

### Patch Changes

- [#1085](#1085)
[`6848e8d`](6848e8d)
Thanks [@jgjgill](https://github.com/jgjgill)! - fix(react): add jsdoc
for shouldCatch prop of ErrorBoundary

## @suspensive/react-query@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
    -   @suspensive/react-query-4@2.6.2
    -   @suspensive/react-query-5@2.6.2

## @suspensive/react-query-4@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2

## @suspensive/react-query-5@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
manudeli pushed a commit that referenced this pull request Aug 3, 2024
)

# Overview

close #952 

Hi, I worked on the docs. 🧐
This is my first time adding docs to this library.
So please feel free to tell me if I'm missing anything.

Thanks for the opportunity. πŸ™‡β€β™‚οΈ

<!--
    A clear and concise description of what this pr is about.
 -->

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------
manudeli added a commit that referenced this pull request Aug 3, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @suspensive/react@2.6.2

### Patch Changes

- [#1085](#1085)
[`6848e8d`](6848e8d)
Thanks [@jgjgill](https://github.com/jgjgill)! - fix(react): add jsdoc
for shouldCatch prop of ErrorBoundary

## @suspensive/react-query@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
    -   @suspensive/react-query-4@2.6.2
    -   @suspensive/react-query-5@2.6.2

## @suspensive/react-query-4@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2

## @suspensive/react-query-5@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
manudeli added a commit that referenced this pull request Aug 3, 2024
)

# Overview

close #952 

Hi, I worked on the docs. 🧐
This is my first time adding docs to this library.
So please feel free to tell me if I'm missing anything.

Thanks for the opportunity. πŸ™‡β€β™‚οΈ

<!--
    A clear and concise description of what this pr is about.
 -->

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
manudeli added a commit that referenced this pull request Aug 3, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @suspensive/react@2.6.2

### Patch Changes

- [#1085](#1085)
[`6848e8d`](6848e8d)
Thanks [@jgjgill](https://github.com/jgjgill)! - fix(react): add jsdoc
for shouldCatch prop of ErrorBoundary

## @suspensive/react-query@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
    -   @suspensive/react-query-4@2.6.2
    -   @suspensive/react-query-5@2.6.2

## @suspensive/react-query-4@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2

## @suspensive/react-query-5@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
manudeli added a commit that referenced this pull request Aug 3, 2024
)

# Overview

close #952 

Hi, I worked on the docs. 🧐
This is my first time adding docs to this library.
So please feel free to tell me if I'm missing anything.

Thanks for the opportunity. πŸ™‡β€β™‚οΈ

<!--
    A clear and concise description of what this pr is about.
 -->

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
manudeli added a commit that referenced this pull request Aug 3, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @suspensive/react@2.6.2

### Patch Changes

- [#1085](#1085)
[`6848e8d`](6848e8d)
Thanks [@jgjgill](https://github.com/jgjgill)! - fix(react): add jsdoc
for shouldCatch prop of ErrorBoundary

## @suspensive/react-query@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
    -   @suspensive/react-query-4@2.6.2
    -   @suspensive/react-query-5@2.6.2

## @suspensive/react-query-4@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2

## @suspensive/react-query-5@2.6.2

### Patch Changes

- Updated dependencies
\[[`6848e8d`](6848e8d)]:
    -   @suspensive/react@2.6.2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: add doc for shouldCatch prop
3 participants