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

Json xml #26

Merged
merged 16 commits into from
Sep 28, 2023
Merged

Json xml #26

merged 16 commits into from
Sep 28, 2023

Conversation

KamyaPA
Copy link
Contributor

@KamyaPA KamyaPA commented Sep 26, 2023

Closes #15

Changes/Additions:

  • Deserialization an serialization from json of each sample type
  • Moved everything into own file
  • Added jsdoc documentation

package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@AlbertHald AlbertHald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@KamyaPA KamyaPA merged commit c2d6ca6 into main Sep 28, 2023
@KamyaPA KamyaPA deleted the json-xml branch September 28, 2023 09:05
Copy link
Collaborator

@atjn atjn left a 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:

image

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:

image

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.

@atjn
Copy link
Collaborator

atjn commented Sep 29, 2023

@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 :)

@atjn
Copy link
Collaborator

atjn commented Sep 29, 2023

Btw, it is hard to search for ? because there will be a thousand lines of code that is using the questionmark legitimately. It is much better to use TODO, as that will only be present in places where there is work to be done.

image

@atjn atjn mentioned this pull request Sep 29, 2023
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

Successfully merging this pull request may close these issues.

[Feature] Parse and Serialize JSON and XML
4 participants