search

preactjs / signals

Manage state with style in every framework
https://preactjs.com/blog/introducing-signals/
MIT License
3.62k stars 88 forks source link

docs(core): add JSDocs for exported module members #531

Closed jviide closed 3 months ago

jviide commented 3 months ago

This pull request adds rudimentary JSDocs for all exported members of the core module.

The JSDoc contents are mostly mixed & matched from the README.md and the Preact website.

I renamed the compute arguments to fn and the internal _compute properties to _fn to align with external documentation. The mangle.json needed to be updated accordingly, with some unrelated formatting changes by the automation.

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 582f0746a93f21947c517770fc61436a428c5447

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

netlify[bot] commented 3 months ago

Deploy Preview for preact-signals-demo ready!

Name Link
Latest commit 582f0746a93f21947c517770fc61436a428c5447
Latest deploy log https://app.netlify.com/sites/preact-signals-demo/deploys/65f5322b1923ac0008fb32e8
Deploy Preview https://deploy-preview-531--preact-signals-demo.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.