docs(navigation): fix error with default segment naming (ionic-team#13022)

jamesgroat · brandyscarney · commit 97c639a59f4d · 2018-03-09T12:37:43.000-05:00
* docs: fix error re: default segment naming The docs incorrectly state how segments get their default names. See commit ionic-team/ionic-app-scripts@5a97ba5. Add note about name and segment properties needing to be unique. ionic-team/ionic-app-scripts@63c4c7f * fix formatting * fix punctuation
diff --git a/src/navigation/ionic-page.ts b/src/navigation/ionic-page.ts
@@ -79,7 +79,8 @@ export interface IonicPageMetadata {
  *
  * The `@IonicPage` decorator accepts a `DeepLinkMetadataType` object. This object accepts
  * the following properties: `name`, `segment`, `defaultHistory`, and `priority`. All of them
- * are optional but can be used to create complex navigation links.
+ * are optional but can be used to create complex navigation links. The `name` and `segment`
+ * values must be unique.
  *
  *
  * ### Changing Name
@@ -108,9 +109,10 @@ export interface IonicPageMetadata {
  * ### Setting URL Path
  *
  * The `segment` property is used to set the URL to the page. If this property isn't provided, the
- * `segment` will use the value of `name`. Since components can be loaded anywhere in the app, the
- * `segment` doesn't require a full URL path. When a page becomes the active page, the `segment` is
- * appended to the URL.
+ * `segment` will use the value of source file name without the extension (`'my-page.ts'` results
+ * in segment name `'my-page'`). Since components can be loaded anywhere in the app, the `segment`
+ * doesn't require a full URL path. When a page becomes the active page, the `segment` is appended
+ * to the URL.
  *
  * The `segment` can be changed to anything and doesn't have to match the `name`. For example, passing
  * a value for `name` and `segment`:

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,8 @@ export interface IonicPageMetadata {`
`79`	`79`	`*`
`80`	`80`	* The `@IonicPage` decorator accepts a `DeepLinkMetadataType` object. This object accepts
`81`	`81`	* the following properties: `name`, `segment`, `defaultHistory`, and `priority`. All of them
`82`		`- * are optional but can be used to create complex navigation links.`
	`82`	+ * are optional but can be used to create complex navigation links. The `name` and `segment`
	`83`	`+ * values must be unique.`
`83`	`84`	`*`
`84`	`85`	`*`
`85`	`86`	`* ### Changing Name`
`@@ -108,9 +109,10 @@ export interface IonicPageMetadata {`
`108`	`109`	`* ### Setting URL Path`
`109`	`110`	`*`
`110`	`111`	* The `segment` property is used to set the URL to the page. If this property isn't provided, the
`111`		- * `segment` will use the value of `name`. Since components can be loaded anywhere in the app, the
`112`		- * `segment` doesn't require a full URL path. When a page becomes the active page, the `segment` is
`113`		`- * appended to the URL.`
	`112`	+ * `segment` will use the value of source file name without the extension (`'my-page.ts'` results
	`113`	+ * in segment name `'my-page'`). Since components can be loaded anywhere in the app, the `segment`
	`114`	+ * doesn't require a full URL path. When a page becomes the active page, the `segment` is appended
	`115`	`+ * to the URL.`
`114`	`116`	`*`
`115`	`117`	* The `segment` can be changed to anything and doesn't have to match the `name`. For example, passing
`116`	`118`	* a value for `name` and `segment`: