update async method descriptions per team discussion

Author: mmalerba

src/material/autocomplete/testing/autocomplete-harness.ts

@@ -39,12 +39,12 @@ export class MatAutocompleteHarness extends ComponentHarness {
             (harness, value) => HarnessPredicate.stringMatches(harness.getValue(), value));
   }
 
-  /** Gets a promise for the value of the autocomplete input. */
+  /** Gets the value of the autocomplete input. */
   async getValue(): Promise<string> {
     return (await this.host()).getProperty('value');
   }
 
-  /** Gets a boolean promise indicating if the autocomplete input is disabled. */
+  /** Whether the autocomplete input is disabled. */
   async isDisabled(): Promise<boolean> {
     const disabled = (await this.host()).getAttribute('disabled');
     return coerceBooleanProperty(await disabled);
@@ -65,12 +65,12 @@ export class MatAutocompleteHarness extends ComponentHarness {
     return (await this.host()).sendKeys(value);
   }
 
-  /** Gets a promise for the options inside the autocomplete panel. */
+  /** Gets the options inside the autocomplete panel. */
   async getOptions(filters: OptionHarnessFilters = {}): Promise<MatAutocompleteOptionHarness[]> {
     return this._documentRootLocator.locatorForAll(MatAutocompleteOptionHarness.with(filters))();
   }
 
-  /** Gets a promise for the option groups inside the panel. */
+  /** Gets the option groups inside the autocomplete panel. */
   async getOptionGroups(filters: OptionGroupHarnessFilters = {}):
       Promise<MatAutocompleteOptionGroupHarness[]> {
     return this._documentRootLocator.locatorForAll(
@@ -87,7 +87,7 @@ export class MatAutocompleteHarness extends ComponentHarness {
     await options[0].select();
   }
 
-  /** Gets a boolean promise indicating whether the autocomplete is open. */
+  /** Whether the autocomplete is open. */
   async isOpen(): Promise<boolean> {
     const panel = await this._optionalPanel();
     return !!panel && await panel.hasClass('mat-autocomplete-visible');

src/material/autocomplete/testing/option-harness.ts

@@ -50,7 +50,7 @@ export class MatAutocompleteOptionHarness extends ComponentHarness {
     return (await this.host()).click();
   }
 
-  /** Gets a promise for the option's label text. */
+  /** Gets the option's label text. */
   async getText(): Promise<string> {
     return (await this.host()).text();
   }
@@ -75,7 +75,7 @@ export class MatAutocompleteOptionGroupHarness extends ComponentHarness {
             (harness, label) => HarnessPredicate.stringMatches(harness.getLabelText(), label));
   }
 
-  /** Gets a promise for the option group's label text. */
+  /** Gets the option group's label text. */
   async getLabelText(): Promise<string> {
     return (await this._label()).text();
   }

src/material/button/testing/button-harness.ts

@@ -42,13 +42,13 @@ export class MatButtonHarness extends ComponentHarness {
     return (await this.host()).click();
   }
 
-  /** Gets a boolean promise indicating if the button is disabled. */
+  /** Whether the button is disabled. */
   async isDisabled(): Promise<boolean> {
     const disabled = (await this.host()).getAttribute('disabled');
     return coerceBooleanProperty(await disabled);
   }
 
-  /** Gets a promise for the button's label text. */
+  /** Gets the button's label text. */
   async getText(): Promise<string> {
     return (await this.host()).text();
   }

src/material/checkbox/testing/checkbox-harness.ts

@@ -36,57 +36,57 @@ export class MatCheckboxHarness extends ComponentHarness {
   private _input = this.locatorFor('input');
   private _inputContainer = this.locatorFor('.mat-checkbox-inner-container');
 
-  /** Gets a boolean promise indicating if the checkbox is checked. */
+  /** Whether the checkbox is checked. */
   async isChecked(): Promise<boolean> {
     const checked = (await this._input()).getProperty('checked');
     return coerceBooleanProperty(await checked);
   }
 
-  /** Gets a boolean promise indicating if the checkbox is in an indeterminate state. */
+  /** Whether the checkbox is in an indeterminate state. */
   async isIndeterminate(): Promise<boolean> {
     const indeterminate = (await this._input()).getProperty('indeterminate');
     return coerceBooleanProperty(await indeterminate);
   }
 
-  /** Gets a boolean promise indicating if the checkbox is disabled. */
+  /** Whether the checkbox is disabled. */
   async isDisabled(): Promise<boolean> {
     const disabled = (await this._input()).getAttribute('disabled');
     return coerceBooleanProperty(await disabled);
   }
 
-  /** Gets a boolean promise indicating if the checkbox is required. */
+  /** Whether the checkbox is required. */
   async isRequired(): Promise<boolean> {
     const required = (await this._input()).getProperty('required');
     return coerceBooleanProperty(await required);
   }
 
-  /** Gets a boolean promise indicating if the checkbox is valid. */
+  /** Whether the checkbox is valid. */
   async isValid(): Promise<boolean> {
     const invalid = (await this.host()).hasClass('ng-invalid');
     return !(await invalid);
   }
 
-  /** Gets a promise for the checkbox's name. */
+  /** Gets the checkbox's name. */
   async getName(): Promise<string|null> {
     return (await this._input()).getAttribute('name');
   }
 
-  /** Gets a promise for the checkbox's value. */
+  /** Gets the checkbox's value. */
   async getValue(): Promise<string|null> {
     return (await this._input()).getProperty('value');
   }
 
-  /** Gets a promise for the checkbox's aria-label. */
+  /** Gets the checkbox's aria-label. */
   async getAriaLabel(): Promise<string|null> {
     return (await this._input()).getAttribute('aria-label');
   }
 
-  /** Gets a promise for the checkbox's aria-labelledby. */
+  /** Gets the checkbox's aria-labelledby. */
   async getAriaLabelledby(): Promise<string|null> {
     return (await this._input()).getAttribute('aria-labelledby');
   }
 
-  /** Gets a promise for the checkbox's label text. */
+  /** Gets the checkbox's label text. */
   async getLabelText(): Promise<string> {
     return (await this._label()).text();
   }

src/material/dialog/testing/dialog-harness.ts

@@ -27,30 +27,30 @@ export class MatDialogHarness extends ComponentHarness {
     return new HarnessPredicate(MatDialogHarness, options);
   }
 
-  /** Gets a promise for the id of the dialog. */
+  /** Gets the id of the dialog. */
   async getId(): Promise<string|null> {
     const id = await (await this.host()).getAttribute('id');
     // In case no id has been specified, the "id" property always returns
     // an empty string. To make this method more explicit, we return null.
     return id !== '' ? id : null;
   }
 
-  /** Gets a promise for the role of the dialog. */
+  /** Gets the role of the dialog. */
   async getRole(): Promise<DialogRole|null> {
     return (await this.host()).getAttribute('role') as Promise<DialogRole|null>;
   }
 
-  /** Gets a promise for the value of the dialog's "aria-label" attribute. */
+  /** Gets the value of the dialog's "aria-label" attribute. */
   async getAriaLabel(): Promise<string|null> {
     return (await this.host()).getAttribute('aria-label');
   }
 
-  /** Gets a promise for the value of the dialog's "aria-labelledby" attribute. */
+  /** Gets the value of the dialog's "aria-labelledby" attribute. */
   async getAriaLabelledby(): Promise<string|null> {
     return (await this.host()).getAttribute('aria-labelledby');
   }
 
-  /** Gets a promise for the value of the dialog's "aria-describedby" attribute. */
+  /** Gets the value of the dialog's "aria-describedby" attribute. */
   async getAriaDescribedby(): Promise<string|null> {
     return (await this.host()).getAttribute('aria-describedby');
   }

src/material/menu/testing/menu-harness.ts

@@ -31,18 +31,18 @@ export class MatMenuHarness extends ComponentHarness {
             (harness, text) => HarnessPredicate.stringMatches(harness.getTriggerText(), text));
   }
 
-  /** Gets a boolean promise indicating if the menu is disabled. */
+  /** Whether the menu is disabled. */
   async isDisabled(): Promise<boolean> {
     const disabled = (await this.host()).getAttribute('disabled');
     return coerceBooleanProperty(await disabled);
   }
 
-  /** Gets a boolean promise indicating whether the menu is open. */
+  /** Whether the menu is open. */
   async isOpen(): Promise<boolean> {
     return !!(await this._getMenuPanel());
   }
 
-  /** Gets a promise for the text of the menu's trigger element. */
+  /** Gets the text of the menu's trigger element. */
   async getTriggerText(): Promise<string> {
     return (await this.host()).text();
   }
@@ -73,7 +73,7 @@ export class MatMenuHarness extends ComponentHarness {
   }
 
   /**
-   * Gets a promise for a list of `MatMenuItemHarness` representing the items in the menu.
+   * Gets a list of `MatMenuItemHarness` representing the items in the menu.
    * @param filters Optionally filters which menu items are included.
    */
   async getItems(filters: Omit<MenuItemHarnessFilters, 'ancestor'> = {}):
@@ -114,13 +114,13 @@ export class MatMenuHarness extends ComponentHarness {
     return menu.clickItem(...subItemFilters as [Omit<MenuItemHarnessFilters, 'ancestor'>]);
   }
 
-  /** Gets a promise for the menu panel associated with this menu. */
+  /** Gets the menu panel associated with this menu. */
   private async _getMenuPanel(): Promise<TestElement | null> {
     const panelId = await this._getPanelId();
     return panelId ? this._documentRootLocator.locatorForOptional(`#${panelId}`)() : null;
   }
 
-  /** Gets a promise for the id of the menu panel associated with this menu. */
+  /** Gets the id of the menu panel associated with this menu. */
   private async _getPanelId(): Promise<string | null> {
     const panelId = await (await this.host()).getAttribute('aria-controls');
     return panelId || null;
@@ -147,13 +147,13 @@ export class MatMenuItemHarness extends ComponentHarness {
             async (harness, hasSubmenu) => (await harness.hasSubmenu()) === hasSubmenu);
   }
 
-  /** Gets a boolean promise indicating if the menu is disabled. */
+  /** Whether the menu is disabled. */
   async isDisabled(): Promise<boolean> {
     const disabled = (await this.host()).getAttribute('disabled');
     return coerceBooleanProperty(await disabled);
   }
 
-  /** Gets a promise for the text of the menu item. */
+  /** Gets the text of the menu item. */
   async getText(): Promise<string> {
     return (await this.host()).text();
   }
@@ -173,12 +173,12 @@ export class MatMenuItemHarness extends ComponentHarness {
     return (await this.host()).click();
   }
 
-  /** Gets a boolean promise indicating whether this item has a submenu. */
+  /** Whether this item has a submenu. */
   async hasSubmenu(): Promise<boolean> {
     return (await this.host()).matchesSelector(MatMenuHarness.hostSelector);
   }
 
-  /** Gets a promise for the submenu associated with this menu item, or null if none. */
+  /** Gets the submenu associated with this menu item, or null if none. */
   async getSubmenu(): Promise<MatMenuHarness | null> {
     if (await this.hasSubmenu()) {
       return new MatMenuHarness(this.locatorFactory);

src/material/progress-bar/testing/progress-bar-harness.ts

@@ -25,14 +25,14 @@ export class MatProgressBarHarness extends ComponentHarness {
     return new HarnessPredicate(MatProgressBarHarness, options);
   }
 
-  /** Gets a promise for the progress bar's value. */
+  /** Gets the progress bar's value. */
   async getValue(): Promise<number|null> {
     const host = await this.host();
     const ariaValue = await host.getAttribute('aria-valuenow');
     return ariaValue ? coerceNumberProperty(ariaValue) : null;
   }
 
-  /** Gets a promise for the progress bar's mode. */
+  /** Gets the progress bar's mode. */
   async getMode(): Promise<string|null> {
     return (await this.host()).getAttribute('mode');
   }

src/material/progress-spinner/testing/progress-spinner-harness.ts

@@ -27,14 +27,14 @@ export class MatProgressSpinnerHarness extends ComponentHarness {
     return new HarnessPredicate(MatProgressSpinnerHarness, options);
   }
 
-  /** Gets a promise for the progress spinner's value. */
+  /** Gets the progress spinner's value. */
   async getValue(): Promise<number|null> {
     const host = await this.host();
     const ariaValue = await host.getAttribute('aria-valuenow');
     return ariaValue ? coerceNumberProperty(ariaValue) : null;
   }
 
-  /** Gets a promise for the progress spinner's mode. */
+  /** Gets the progress spinner's mode. */
   async getMode(): Promise<ProgressSpinnerMode> {
     const modeAttr = (await this.host()).getAttribute('mode');
     return await modeAttr as ProgressSpinnerMode;

src/material/radio/testing/radio-harness.ts

@@ -26,7 +26,7 @@ export class MatRadioGroupHarness extends ComponentHarness {
         .addOption('name', options.name, this._checkRadioGroupName);
   }
 
-  /** Gets a promise for the name of the radio-group. */
+  /** Gets the name of the radio-group. */
   async getName(): Promise<string|null> {
     const hostName = await this._getGroupNameFromHost();
     // It's not possible to always determine the "name" of a radio-group by reading
@@ -48,12 +48,12 @@ export class MatRadioGroupHarness extends ComponentHarness {
     return radioNames[0]!;
   }
 
-  /** Gets a promise for the id of the radio-group. */
+  /** Gets the id of the radio-group. */
   async getId(): Promise<string|null> {
     return (await this.host()).getProperty('id');
   }
 
-  /** Gets a promise for the checked radio-button in a radio-group. */
+  /** Gets the checked radio-button in a radio-group. */
   async getCheckedRadioButton(): Promise<MatRadioButtonHarness|null> {
     for (let radioButton of await this.getRadioButtons()) {
       if (await radioButton.isChecked()) {
@@ -63,7 +63,7 @@ export class MatRadioGroupHarness extends ComponentHarness {
     return null;
   }
 
-  /** Gets a promise for the checked value of the radio-group. */
+  /** Gets the checked value of the radio-group. */
   async getCheckedValue(): Promise<string|null> {
     const checkedRadio = await this.getCheckedRadioButton();
     if (!checkedRadio) {
@@ -73,7 +73,7 @@ export class MatRadioGroupHarness extends ComponentHarness {
   }
 
   /**
-   * Gets a promise for a list of radio buttons which are part of the radio-group.
+   * Gets a list of radio buttons which are part of the radio-group.
    * @param filter Optionally filters which radio buttons are included.
    */
   async getRadioButtons(filter: RadioButtonHarnessFilters = {}): Promise<MatRadioButtonHarness[]> {
@@ -93,12 +93,12 @@ export class MatRadioGroupHarness extends ComponentHarness {
     return radioButtons[0].check();
   }
 
-  /** Gets a promise for the name attribute of the host element. */
+  /** Gets the name attribute of the host element. */
   private async _getGroupNameFromHost() {
     return (await this.host()).getAttribute('name');
   }
 
-  /** Gets a promise for list of the name attributes of all child radio buttons. */
+  /** Gets a list of the name attributes of all child radio buttons. */
   private async _getNamesFromRadioButtons(): Promise<string[]> {
     const groupNames: string[] = [];
     for (let radio of await this.getRadioButtons()) {
@@ -177,37 +177,36 @@ export class MatRadioButtonHarness extends ComponentHarness {
   private _clickLabel = this.locatorFor('.mat-radio-label');
   private _input = this.locatorFor('input');
 
-  /** Gets a boolean promise indicating whether the radio-button is checked. */
+  /** Whether the radio-button is checked. */
   async isChecked(): Promise<boolean> {
     const checked = (await this._input()).getProperty('checked');
     return coerceBooleanProperty(await checked);
   }
 
-  /** Gets a boolean promise indicating whether the radio-button is disabled. */
+  /** Whether the radio-button is disabled. */
   async isDisabled(): Promise<boolean> {
     const disabled = (await this._input()).getAttribute('disabled');
     return coerceBooleanProperty(await disabled);
   }
 
-  /** Gets a boolean promise indicating whether the radio-button is required. */
+  /** Whether the radio-button is required. */
   async isRequired(): Promise<boolean> {
     const required = (await this._input()).getAttribute('required');
     return coerceBooleanProperty(await required);
   }
 
-  /** Gets a promise for the radio-button's name. */
+  /** Gets the radio-button's name. */
   async getName(): Promise<string|null> {
     return (await this._input()).getAttribute('name');
   }
 
-  /** Gets a promise for the radio-button's id. */
+  /** Gets the radio-button's id. */
   async getId(): Promise<string|null> {
     return (await this.host()).getProperty('id');
   }
 
   /**
-   * Gets a promise for the value of the radio-button. The radio-button value will be
-   * converted to a string.
+   * Gets the value of the radio-button. The radio-button value will be converted to a string.
    *
    * Note: This means that for radio-button's with an object as a value `[object Object]` is
    * intentionally returned.
@@ -216,7 +215,7 @@ export class MatRadioButtonHarness extends ComponentHarness {
     return (await this._input()).getProperty('value');
   }
 
-  /** Gets a promise for the radio-button's label text. */
+  /** Gets the radio-button's label text. */
   async getLabelText(): Promise<string> {
     return (await this._textLabel()).text();
   }