[DOC] Document setupController hook behavior when model is undefined #14982
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The default implementation doesn't update the `model` property of the controller if the resolved model is undefined. This isn't currently documented.
Bestra
changed the title
rwjblue
reviewed
Apr 3, 2017
| @@ -1703,7 +1703,8 @@ let Route = EmberObject.extend(ActionHandler, Evented, { | |||
| model supplied by the `model` hook. | |||
|
|
|||
| By default, the `setupController` hook sets the `model` property of | |||
| the controller to the `model`. | |||
| the controller to the `model`. If `model` is `undefined`, the default | |||
There was a problem hiding this comment.
Instead of stating the default then correcting it with what happens when model is undefined, can we tweak how we state the default?
Perhaps something like:
By default, the
setupControllerhook sets themodelproperty of the controller to themodelspecified when it is notundefined.
One good sentence is better than two.
|
Thanks @Bestra :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The default hook implementation doesn't update the
modelproperty of the controllerif the resolved model is undefined, and I don't think that behavior is recorded anywhere except the source itself.