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

Incorrect @default Comments in BaseKitOptions Interface #397

Open
MohamedElGhandour opened this issue Nov 18, 2024 · 0 comments
Open

Incorrect @default Comments in BaseKitOptions Interface #397

MohamedElGhandour opened this issue Nov 18, 2024 · 0 comments

Comments

@MohamedElGhandour
Copy link

Description:

There is an inconsistency in the comments for the @default values in the BaseKitOptions interface. Specifically, the comments indicate that certain options have a default value of true, while the actual default value in the code is set to false.

For example:

  • Current code: document:false, text: false, gapcursor: false, etc.
  • Current comment: @default true

Steps to Reproduce:

  1. Open the BaseKitOptions interface in the codebase.
  2. Observe that many options (such as document, text, gapcursor, etc.) have the @default true comment, even though their default value is false.

Expected Behavior:

The @default comments should correctly reflect the actual default values in the code.

Actual Behavior:

The comment for options like document, text, gapcursor, and others state that their default value is true, but the actual value is false.

Suggested Fix:

Update the comments to correctly represent the default values:

  • Change @default true to @default false for options that default to false.

Example:

/**
 * @default false
 */
document: false

/**
 * @default false
 */
text: false

/**
 * @default false
 */
gapcursor: false

Why is this important?

  • Clear and accurate documentation helps developers understand the expected behavior without needing to dig into the code.

  • It prevents confusion when working with these options and makes the code more maintainable.

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

No branches or pull requests

1 participant