Skip to content

docs: add missing jsdocs#171

Merged
pi0 merged 4 commits into
unjs:mainfrom
onmax:main
Apr 17, 2024
Merged

docs: add missing jsdocs#171
pi0 merged 4 commits into
unjs:mainfrom
onmax:main

Conversation

@onmax

@onmax onmax commented Apr 8, 2024

Copy link
Copy Markdown
Contributor

Added JSDocs to exported functions

🔗 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

📝 Checklist

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

Any feedback is welcomed! 🙌

@codecov

codecov Bot commented Apr 17, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.37%. Comparing base (afdf7cb) to head (36a56b7).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #171      +/-   ##
==========================================
+ Coverage   89.40%   90.37%   +0.96%     
==========================================
  Files           5        5              
  Lines         434      540     +106     
  Branches       37       36       -1     
==========================================
+ Hits          388      488     +100     
- Misses         46       52       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pi0 pi0 changed the title docs: added missing jsdocs docs: add missing jsdocs Apr 17, 2024

@pi0 pi0 left a comment

Copy link
Copy Markdown
Member

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 20c42e6 into unjs:main Apr 17, 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.

2 participants