-
Notifications
You must be signed in to change notification settings - Fork 0
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
Json xml #26
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't have a chance to review this before it was merged, but I would have liked to see better comments. Many of them are stating something you can already read, like this one:
Some of them are adding more information, but I would argue that that information should have been in the variable names. For example, this should probably have been called a NailProperty
:
The style guide that you are using also has a section for this: https://google.github.io/styleguide/tsguide.html#redundant-comments
A better comment would say "this property is being used by fn1
and fn2
to do this", or "this function is using these and these features to solve this problem". Design considerations and gotcha's are also welcome. "we made this property to solve x problem, be aware that if you want to do y, there is an issue with this".
If you don't know what they are being used for, or don't know what to write that could be helpful, it is better to add a comment with a TODO: Document the use of this prop
, because this makes us able to search the codebase for "TODO" and fix things later when we have more knowledge.
@KamyaPA I don't know if this is something that you want to work on yourself? I can also add an issue, and we can put it into our sprint at some point :) |
Closes #15
Changes/Additions: