docs: add jsdocs for top-level functions - Githubissues

unjs / consola

🐨 Elegant Console Logger for Node.js and Browser

Other

6k stars 175 forks source link

docs: add jsdocs for top-level functions #288

Closed onmax closed 3 months ago

onmax commented 5 months ago

Added JSDocs to top level functions. This is a continuation work from #286.

🔗 Linked issue

❓ Type of change

[X] 📖 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

[X] I have linked an issue or discussion.
[ ] I have updated the documentation accordingly.

Any feedback is welcomed! 🙌