Clean up alias & getter documentation

san650 · Oct 1, 2017 · e79594e · e79594e
1 parent 0478ba2
commit e79594e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/addon/-private/properties/alias.js b/addon/-private/properties/alias.js
@@ -18,7 +18,7 @@ const ALIASED_PROP_NOT_FOUND = 'PageObject does not contain aliased property';
  * const page = create({
  *   submitButton: {
  *     scope: '.submit-button'
- *   }
+ *   },
  *   submit: alias('submitButton.click')
  * });
  *
@@ -33,7 +33,7 @@ const ALIASED_PROP_NOT_FOUND = 'PageObject does not contain aliased property';
  * const page = create({
  *   submitButton: {
  *     scope: '.submit-button'
- *   }
+ *   },
  *   isSubmitButtonVisible: alias('submitButton.isVisible')
  * });
  *
@@ -47,7 +47,7 @@ const ALIASED_PROP_NOT_FOUND = 'PageObject does not contain aliased property';
  *
  * const page = create({
  *   form: {
- *     input {
+ *     input: {
  *       scope: 'input'
  *     },
  *     submitButton: {
@@ -62,7 +62,6 @@ const ALIASED_PROP_NOT_FOUND = 'PageObject does not contain aliased property';
  * // and causes both methods to return `page` (instead of `page.form.input`
  * // and `page.form.submitButton` respectively) so that the aliased methods
  * // can be chained off `page`.
- *
  * page
  *   .fillFormInput('foo')
  *   .submitForm();

diff --git a/addon/-private/properties/getter.js b/addon/-private/properties/getter.js
@@ -10,7 +10,7 @@ const NOT_A_FUNCTION_ERROR = 'Argument passed to `getter` must be a function.';
  * @example
  *
  * // <input type="text">
- * // <button>Submit</button>
+ * // <button disabled>Submit</button>
  *
  * import { create } from 'ember-cli-page-object';
  * import { getter } from 'ember-cli-page-object/macros';