Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

docs(dialog): correct and add back resolve property #11164

Merged
merged 1 commit into from
Mar 16, 2018

Conversation

karansapolia
Copy link
Contributor

@karansapolia karansapolia commented Mar 13, 2018

PR Checklist

Please check that your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?
Changes docs. Corrects and adds back resolve property doc in the $mdDialog.show() parameters list.

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

Currently the resolve property is not listed or described in the $mdDialog.show(optionsOrPreset) parameters documentation. Refer to issue #7400. But as suggested in comments, slight documentation correction was required for the property.

Issue Number:
#11159

What is the new behavior?

The documentation for the resolve property has been updated and added back.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers
  • Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the project maintainer to go/cla#troubleshoot.
  • The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
  • The email used to register you as an authorized contributor must also be attached to your GitHub account.

@googlebot googlebot added the cla: no PR author needs to sign Google's CLA: https://opensource.google.com/docs/cla/ label Mar 13, 2018
@karansapolia
Copy link
Contributor Author

I signed it!

@googlebot
Copy link

CLAs look good, thanks!

@googlebot googlebot added cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ and removed cla: no PR author needs to sign Google's CLA: https://opensource.google.com/docs/cla/ labels Mar 13, 2018
@Splaktar Splaktar self-requested a review March 13, 2018 18:43
@Splaktar Splaktar self-assigned this Mar 13, 2018
Copy link
Contributor

@Splaktar Splaktar left a comment

Choose a reason for hiding this comment

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

Thank you for sending this PR!

I think that one minor change to the type will help make this more clear.

@@ -536,6 +536,8 @@ function MdDialogDirective($$rAF, $mdTheming, $mdDialog) {
* `three` into the controller, with the value 3. If `bindToController` is true, they will be
* copied to the controller instead.
* - `bindToController` - `bool`: bind the locals to the controller, instead of passing them in.
* - `resolve` - `{object=}`: Similar to locals, except it takes as values functions that return promises, and the
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's change {object=} to {function=} to match the changes to the text.

Copy link
Contributor Author

@karansapolia karansapolia Mar 14, 2018

Choose a reason for hiding this comment

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

Oops. Correcting it right away.

@Splaktar Splaktar added pr: merge safe in progress Mainly for in progress PRs, but may be used for issues that require multiple PRs labels Mar 13, 2018
@Splaktar Splaktar added this to the 1.1.8 milestone Mar 13, 2018
@Splaktar Splaktar added type: docs P3: important Important issues that really should be fixed when possible. labels Mar 13, 2018
@karansapolia
Copy link
Contributor Author

karansapolia commented Mar 14, 2018

@Splaktar This was just a docs edit. Ideally build should not fail. Read from other PRs that there was a Travis CI outage last night affecting the tests.

@Splaktar
Copy link
Contributor

Yep, don't worry about that test failure. Can you please squash your commits and update the commit message to have Closes #11159 on the last line?

@Splaktar Splaktar removed the in progress Mainly for in progress PRs, but may be used for issues that require multiple PRs label Mar 15, 2018
Copy link
Contributor

@Splaktar Splaktar left a comment

Choose a reason for hiding this comment

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

LGTM once squashed and commit message updated.

@karansapolia karansapolia force-pushed the master branch 2 times, most recently from bbb50c0 to dad30ab Compare March 15, 2018 12:28
@karansapolia
Copy link
Contributor Author

karansapolia commented Mar 15, 2018

👍 Squashed and commit message updated. Thank you for bearing with me.

Corrected resolve property description

Closes angular#11159
@Splaktar Splaktar added pr: merge ready This PR is ready for a caretaker to review and removed needs: squash commits labels Mar 16, 2018
@Splaktar
Copy link
Contributor

No problem at all. I understand that we have some requirements and elements of our process that take some time to learn! Thank you for keeping with it and making the requested updates!

@mmalerba mmalerba merged commit 52efe32 into angular:master Mar 16, 2018
chmelevskij pushed a commit to chmelevskij/material that referenced this pull request Jun 19, 2018
Splaktar pushed a commit that referenced this pull request Jul 31, 2018
Corrected resolve property description

Closes #11159
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ P3: important Important issues that really should be fixed when possible. pr: merge ready This PR is ready for a caretaker to review type: docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants