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

Add JsDoc in order to provide a strict type checking #617

Open
erikyo opened this issue Apr 18, 2024 · 1 comment
Open

Add JsDoc in order to provide a strict type checking #617

erikyo opened this issue Apr 18, 2024 · 1 comment

Comments

@erikyo
Copy link
Collaborator

erikyo commented Apr 18, 2024

Is your feature request related to a problem? Please describe.
Currently, the Vanilla Lazyload repository lacks JSDoc comments within its JavaScript codebase. This absence poses challenges for developers who seek to maintain or extend the codebase with type checking, as it lacks clear documentation about the types of inputs and outputs expected by various functions and methods.

Describe the solution you'd like
I would like to request the addition of JSDoc comments throughout the codebase of Vanilla Lazyload. These comments should adequately describe the parameters, return types, and any relevant information about functions and methods. This addition will not only enhance the code's readability but also enable better type checking and documentation generation using tools like TypeScript or JSDoc.

Describe alternatives you've considered
Without JSDoc comments, developers may resort to manual inspection of the codebase to understand function signatures and expected behaviors. However, this approach is time-consuming, error-prone, and lacks the automation provided by tools like TypeScript or JSDoc.

Additional context
Including JSDoc comments aligns with best practices for JavaScript development and facilitates collaboration among developers. Additionally, it improves the overall maintainability of the codebase by providing clear documentation for future reference.

@erikyo
Copy link
Collaborator Author

erikyo commented Apr 18, 2024

@verlok can you assign this one to me? I am already familiar with this and even recently I have been doing it here

@erikyo erikyo changed the title Add JsDoc in order to provide a stict type checking Add JsDoc in order to provide a strict type checking Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant