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 onHide doc #1748

Closed
wants to merge 1 commit into from
Closed

Add onHide doc #1748

wants to merge 1 commit into from

Conversation

sunnyone
Copy link

@sunnyone sunnyone commented Mar 6, 2018

What is the purpose of this pull request?

Add lacking documentation. The "onHide" property of dialogDefinition is used (for example, plugins/link/dialogs/anchor.js) but it's not described in dialogDefinition.js.

Does your PR contain necessary tests?

No. This PR add a comment only.

What changes did you make?

Add a doc comment to dialogDefinition.js.

@mlewand mlewand added the review:easy Pull requests that can be reviewed by a Junior Developer before being reviewed by the Reviewer. label Mar 6, 2018
@mlewand mlewand requested a review from jacekbogdanski March 7, 2018 14:13
Copy link
Member

@jacekbogdanski jacekbogdanski left a comment

Choose a reason for hiding this comment

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

Looks like we missed this one. LGTM 👍

@mlewand mlewand self-requested a review March 12, 2018 17:14
Copy link
Contributor

@mlewand mlewand left a comment

Choose a reason for hiding this comment

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

Just a minor correction, I'll take it from here.

@@ -128,6 +128,12 @@
* @property {Function} onShow
*/

/**
* The function to execute when the dialog is hidden (executed every time the dialog is closed).
Copy link
Contributor

Choose a reason for hiding this comment

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

This could be simplified down to:

The function executed every time the dialog is closed.

I'll correct this while merging.

@mlewand
Copy link
Contributor

mlewand commented Mar 12, 2018

Merged with 011af64 - it will be published in 4.10.0. Thank you!

@mlewand mlewand closed this Mar 12, 2018
@mlewand mlewand added this to the 4.10.0 milestone Mar 12, 2018
@sunnyone sunnyone deleted the add-on-hide branch April 13, 2018 02:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:easy Pull requests that can be reviewed by a Junior Developer before being reviewed by the Reviewer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants