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 documentation to edit-comments.js #96

Closed
wants to merge 15 commits into from
Closed

Conversation

@Xyfi
Copy link
Member

Xyfi commented Jan 18, 2018

Props to: @manuelaugustin, @diedexx, @thulshof and @Xyfi.
Fixes #30

@@ -1,3 +1,9 @@
/**
* Contains functionality of the admin Comments page.
*
* @since 4.4.0
* @access private
*
* @param el jQuery element.

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please specify the type of the param

* @since 4.4.0
* @access private
*
* @param el jQuery element.

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please specify the type of the params

* @since 4.4.0
* @access private
*
* @param diff The amount to lower or raise the approved count with.

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please specify the type of the params. Applies to the whole file

@@ -44,7 +82,7 @@ var getCount, updateCount, updateCountText, updatePending, updateApproved,
return;
}

// cache selectors to not get dupes
// cache selectors to not get duplicates

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please start with a capital letter and end with a full stop.

*
* @param el jQuery element.
*
* @returns {int} The number found in the given element.

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please use {number} as {int} isn't a valid datatype in JS.
Applies to the entire filie

* @memberOf commentReply
*
* @returns {void}
*/

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please start inline comments in this function with an uppercase letter and end them with full stops

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Could you also change replyrow is not showing? so it's not a question

* @memberOf commentReply
*
* @param {Object} xml Ajax response object.
* @returns {boolean|void} Returns either nothing or false if an error occurred.

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please add a newline between param and returns

*
* @memberOf commentReply
*
* @param {string} r The Ajax response.

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please add newline

*
* @memberOf commentReply
*
* @param post_id The post id.

This comment has been minimized.

Copy link
@diedexx

diedexx Mar 8, 2018

Member

Please add newline

@atimmer

This comment has been minimized.

Copy link
Member

atimmer commented Jun 20, 2019

@atimmer atimmer closed this Jun 20, 2019
@atimmer atimmer deleted the stories/ABTH/edit-comments branch Jun 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.