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(core): add JSDocs for exported module members #531

Merged
merged 2 commits into from
Mar 17, 2024
Merged

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

merged 2 commits into from
Mar 17, 2024

Conversation

jviide
Copy link
Contributor

@jviide jviide commented Mar 16, 2024

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.

Copy link

changeset-bot bot commented Mar 16, 2024

⚠️ No Changeset found

Latest commit: 582f074

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

Copy link

netlify bot commented Mar 16, 2024

Deploy Preview for preact-signals-demo ready!

Name Link
🔨 Latest commit 582f074
🔍 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.

Copy link
Member

@marvinhagemeister marvinhagemeister left a comment

Choose a reason for hiding this comment

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

Sweet 👍

@marvinhagemeister marvinhagemeister merged commit d17ed0d into preactjs:main Mar 17, 2024
6 checks passed
@jviide jviide deleted the docs branch March 17, 2024 15:21
@github-actions github-actions bot mentioned this pull request Mar 19, 2024
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