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

Point API references to new docs entries #2143

Merged
merged 1 commit into from Apr 24, 2024
Merged

Point API references to new docs entries #2143

merged 1 commit into from Apr 24, 2024

Conversation

atilafassina
Copy link
Member

Summary

The documentation entries at solidjs.com/docs are not receiving updates anymore.
So even with the new docs app being still in beta, I believe it's best to already point the JSDoc @description suggestions to docs.solidjs.com

@atilafassina atilafassina added the typescript relating to typescript or types label Apr 23, 2024
@atilafassina atilafassina self-assigned this Apr 23, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Apr 23, 2024

⚠️ No Changeset found

Latest commit: 1f8cc98

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@coveralls
Copy link

Pull Request Test Coverage Report for Build 8806088715

Details

  • 36 of 36 (100.0%) changed or added relevant lines in 7 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 93.56%
Totals Coverage Status
Change from base Build 8792308061: 0.0%
Covered Lines: 4186
Relevant Lines: 4408
💛 - Coveralls

@atilafassina atilafassina mentioned this pull request Apr 23, 2024
Merged
danieljcafonso
danieljcafonso reviewed Apr 23, 2024
View reviewed changes
packages/solid/src/reactive/signal.ts
@@ -1750,7 +1750,7 @@ type TODO = any;
*
* * If the error is thrown again inside the error handler, it will trigger the next available parent handler
*
* @description https://www.solidjs.com/docs/latest/api#onerror
* @description https://www.solidjs.com/docs/latest/api#onerror | https://docs.solidjs.com/reference/reactive-utilities/catch-error
Copy link

Choose a reason for hiding this comment

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

Just out of curiosity, Is there a reason why we kept the previous one here?

Copy link
Member Author

Choose a reason for hiding this comment

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

as far as I can see, onError has not been taken to the new docs because the api is deprecated. So I left the old link and added the link to the recommended alternative

@ryansolid
Copy link
Member

Looks great thanks.

@ryansolid ryansolid merged commit a72d393 into solidjs:main Apr 24, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danieljcafonso danieljcafonso danieljcafonso left review comments

Assignees

@atilafassina atilafassina

Labels
typescript relating to typescript or types
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@atilafassina @coveralls @ryansolid @danieljcafonso