You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Open the BaseKitOptions interface in the codebase.
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.
Description:
There is an inconsistency in the comments for the
@default
values in theBaseKitOptions
interface. Specifically, the comments indicate that certain options have a default value oftrue
, while the actual default value in the code is set tofalse
.For example:
false
,text: false
,gapcursor: false
, etc.@default true
Steps to Reproduce:
BaseKitOptions
interface in the codebase.document
,text
,gapcursor
, etc.) have the@default true
comment, even though their default value isfalse
.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 istrue
, but the actual value isfalse
.Suggested Fix:
Update the comments to correctly represent the default values:
@default true
to@default false
for options that default tofalse
.Example:
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.
The text was updated successfully, but these errors were encountered: