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

Add comments to normalizeData function #33604

Closed

Conversation

Nikos-Antonopoulos
Copy link

@XhmikosR This pull request is part of a project for a university assignment concerning construction quality and specifically good code documentation. There is no need to review this pull request. Feel free to close it or merge it :)

@Nikos-Antonopoulos Nikos-Antonopoulos requested a review from a team as a code owner April 10, 2021 15:58
@GeoSot
Copy link
Member

GeoSot commented Apr 13, 2021

Hey Nikos. thank you for your Pr. You may remove the inline comments and keep only the function doc-block (8-13)

Also try to squash your commits into one and re-base the branch

@Nikos-Antonopoulos
Copy link
Author

@GeoSot, i have applied your suggestions. Hopefully, everything is ok now!

/**
* Returns the val in the correct primitive type.
*
* @param {String} val A value of any primitive type as a String
Copy link
Contributor

@alpadev alpadev Apr 21, 2021

Choose a reason for hiding this comment

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

Shouldn't string be lowercase?

@XhmikosR
Copy link
Member

@Nikos-Antonopoulos this whole PR is a little moot in the sense that we don't use JSDoc comments anywhere else.

So, while I appreciate the effort, unless this is done across the codebase and enforced somehow, it doesn't make sense to proceed with this PR.

@Nikos-Antonopoulos
Copy link
Author

@XhmikosR as I've already mentioned in the first comment, this PR was created for a university assignment and there is no need to review it, so feel free to close it! However, thank you very much for your time!

@XhmikosR
Copy link
Member

Haha, sorry, I thought you actually wanted to land this. All good, then :)

@XhmikosR XhmikosR closed this Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants