Skip to content

docs: better JSDoc#942

Merged
kirillzyusko merged 11 commits intomainfrom
docs/better-js-docs
May 16, 2025
Merged

docs: better JSDoc#942
kirillzyusko merged 11 commits intomainfrom
docs/better-js-docs

Conversation

@kirillzyusko
Copy link
Copy Markdown
Owner

@kirillzyusko kirillzyusko commented May 16, 2025

📜 Description

Better coverage of js-doc.

💡 Motivation and Context

Current state os JSDoc was in semi-ready state. Some of components had JSDoc, some props declaration had JSDoc, but some of them wee missing completely.

I decided to change that, so in this PR I am forcing the JSDoc for each hook/view/component/props. To assure JSDoc looks consistent across all files I added eslint plugin.

Overall I think it's a great addition - documentation is a key to success and when you have it on your fingers tip it makes you more productive 😊

📢 Changelog

JS

  • added eslint plugin to assure documentation is written for each function and is consistent;
  • added missing JSDoc for all public hooks/components/modules.

🤔 How Has This Been Tested?

Tested in VSCode.

📸 Screenshots (if appropriate):

image

📝 Checklist

  • CI successfully passed
  • I added new mocks and corresponding unit-tests if library API was changed

@kirillzyusko kirillzyusko self-assigned this May 16, 2025
@kirillzyusko kirillzyusko added the documentation Improvements or additions to documentation label May 16, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 16, 2025

📊 Package size report

Current size Target Size Difference
197123 bytes 177820 bytes 19303 bytes 📈

@kirillzyusko kirillzyusko marked this pull request as ready for review May 16, 2025 15:57
@kirillzyusko kirillzyusko merged commit 661b39e into main May 16, 2025
15 of 16 checks passed
@kirillzyusko kirillzyusko deleted the docs/better-js-docs branch May 16, 2025 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant