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

refactor: add @fileoverviews and structured comments to .js files #145

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

lumirlumir
Copy link
Owner

This pull request includes several documentation improvements and code organization changes across multiple files to enhance readability and maintainability. The most important changes include adding file-level JSDoc comments, organizing code sections with comments, and ensuring consistent exports.

Documentation improvements:

Code organization:

Copy link

Labels have been automatically applied based on the conventional commit types.🏷️

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (779cc00) to head (fcd7d90).
Report is 1 commits behind head on main.

@@            Coverage Diff            @@
##              main      #145   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines           61        64    +3     
=========================================
+ Hits            61        64    +3     
Files with missing lines Coverage Δ
packages/clang-format-git-python/src/cli.js 100.00% <ø> (ø)
packages/clang-format-git-python/src/index.js 100.00% <ø> (ø)
...-format-git-python/src/utils/gitClangFormatPath.js 100.00% <ø> (ø)
packages/clang-format-git/src/cli.js 100.00% <ø> (ø)
packages/clang-format-git/src/index.js 100.00% <ø> (ø)
...lang-format-git/src/utils/getGitClangFormatPath.js 100.00% <100.00%> (ø)
...s/clang-format-git/src/utils/gitClangFormatPath.js 100.00% <ø> (ø)
packages/clang-format-node/src/cli.js 100.00% <ø> (ø)
packages/clang-format-node/src/index.js 100.00% <ø> (ø)
...ges/clang-format-node/src/utils/clangFormatPath.js 100.00% <100.00%> (ø)
... and 1 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 779cc00...fcd7d90. Read the comment docs.

@lumirlumir lumirlumir merged commit 0c6424a into main Dec 16, 2024
33 checks passed
@lumirlumir lumirlumir deleted the refactor-add-comments branch December 16, 2024 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant