AskJsx resources are not commented at all

[czerwinskilukasz1]

Except for an example written without any explanation in Query.tsx, there is no single .tsx file in src/askjsx/lib which would have any comment on the purpose of the resource and its usage.
Fragment, Fun, Let and Ref are the resources for which I think comments are the most urgent.

[mhagmajer]

Let's start with having some comments in code and then we can add descriptions as a property of the resource function so we have something that an easy documentation can be generated from

[mhagmajer]

BTW, set is used here

export const Let = (props: Props) => <Set {...props} code="let" />;
export const Const = (props: Props) => <Set {...props} code="const" />;
export const Assign = (props: Props) => <Set {...props} code="assign" />;

https://github.com/xFAANG/askql/blob/master/src/askjsx/lib/Let.tsx#L35

@czerwinskilukasz1 seems like eslint has a bug... or perhaps it doesn't understand JSX?

[czerwinskilukasz1]

BTW, set is used here

export const Let = (props: Props) => <Set {...props} code="let" />;
export const Const = (props: Props) => <Set {...props} code="const" />;
export const Assign = (props: Props) => <Set {...props} code="assign" />;

https://github.com/xFAANG/askql/blob/master/src/askjsx/lib/Let.tsx#L35

@czerwinskilukasz1 seems like eslint has a bug... or perhaps it doesn't understand JSX?

Probably. I was going to add // eslint-disable-next-line @typescript-eslint/no-unused-vars there and in one other places, so that we don't get eslint warnings.

[mhagmajer]

@czerwinskilukasz1 maybe we can file this issue with eslint and add a comment about it in Eslint repo? I'd rather not add comments in our code to hide a buggy behavior of Eslint