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

docs: add jsdoc examples #672

Merged
merged 2 commits into from
Feb 25, 2024
Merged

docs: add jsdoc examples #672

merged 2 commits into from
Feb 25, 2024

Conversation

Barbapapazes
Copy link
Member

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Update examples from the JSdoc annotations to improve IDE usage and documentation support.

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@Barbapapazes Barbapapazes added the documentation Improvements or additions to documentation label Feb 25, 2024
@Barbapapazes Barbapapazes self-assigned this Feb 25, 2024
@cloudflare-pages Cloudflare Pages
Copy link

cloudflare-pages bot commented Feb 25, 2024 •
edited

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0be9ac8
Status: ✅  Deploy successful!
Preview URL: https://0b316cab.unjs-h3.pages.dev
Branch Preview URL: https://docs-update-jsdoc-body.unjs-h3.pages.dev

View logs

@Barbapapazes Barbapapazes changed the title docs update jsdoc body docs update jsdocs body Feb 25, 2024
@Barbapapazes Barbapapazes mentioned this pull request Feb 25, 2024
Open
8 tasks
@pi0 pi0 changed the title docs update jsdocs body docs: add jsdoc examples Feb 25, 2024
pi0
pi0 approved these changes Feb 25, 2024
View reviewed changes
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thanks!

@pi0 pi0 merged commit cb35dbe into main Feb 25, 2024
5 checks passed
@pi0 pi0 deleted the docs-update-jsdoc-body branch February 25, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pi0 pi0 pi0 approved these changes

Assignees

@Barbapapazes Barbapapazes

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Barbapapazes @pi0