Skip to content

Commit

Permalink
Merge pull request #2887 from dtarasiuk/doc/state
Browse files Browse the repository at this point in the history
doc(StateService): update StateService doc
  • Loading branch information
christopherthielen authored Jul 26, 2016
2 parents 19d0444 + c68813d commit 9c009c6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/state/stateService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export class StateService {
* </pre>
* <img src='../ngdoc_assets/StateGoExamples.png'/>
*
* @param {string} to Absolute state name or relative state path. Some examples:
* @param {string|object} to Absolute state name, state object, or relative state path. Some examples:
*
* - `$state.go('contact.detail')` - will go to the `contact.detail` state
* - `$state.go('^')` - will go to a parent state
Expand Down Expand Up @@ -242,7 +242,7 @@ export class StateService {
* });
* </pre>
*
* @param {string} to State name.
* @param {string|object} to State name or state object.
* @param {object=} toParams A map of the parameters that will be sent to the state,
* will populate $stateParams.
* @param {object=} options Options object. The options are:
Expand Down Expand Up @@ -401,8 +401,8 @@ export class StateService {
* $state.includes("item.**"); // returns false
* </pre>
*
* @param {string} stateOrName A partial name, relative name, or glob pattern
* to be searched for within the current state name.
* @param {string|object} stateOrName A partial name, relative name, glob pattern,
* or state object to be searched for within the current state name.
* @param {object=} params A param object, e.g. `{sectionId: section.id}`,
* that you'd like to test against the current active state.
* @param {object=} options An options object. The options are:
Expand Down

0 comments on commit 9c009c6

Please sign in to comment.