Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs-bug(button): Missing documentation for MatButtonHarness with() static function #20270

Closed
chivesrs opened this issue Aug 11, 2020 · 3 comments · Fixed by #22786
Closed

docs-bug(button): Missing documentation for MatButtonHarness with() static function #20270

chivesrs opened this issue Aug 11, 2020 · 3 comments · Fixed by #22786
Assignees
Labels
area: dgeni Issue related to API docs extraction docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround

Comments

@chivesrs
Copy link

Documentation Feedback

https://material.angular.io/components/button/api#MatButtonHarness

There is a static with() function that lets you find the right instance of mat-button on the page, yet this documentation doesn't support it.

https://material.angular.io/guide/using-component-harnesses states

You can also use the static with method implemented on all Angular Material component harnesses. This method creates a HarnessPredicate, an object that filters loaded harnesses based on the provided constraints. The particular constraint options vary depending on the harness class, but all harnesses support at least:

The docs for the with() function should exist on the Harness docs page as well, and not on this random guide.

Here is the function I am talking about:
https://github.com/angular/components/blob/master/src/material/button/testing/button-harness.ts#L34

@chivesrs chivesrs added docs This issue is related to documentation needs triage This issue needs to be triaged by the team labels Aug 11, 2020
@chivesrs
Copy link
Author

Lumping this in but can file a new bug if needed.

https://material.angular.io/components/button/api#ButtonHarnessFilters states that there is a text filter on the filter interface. But, there is also the selector and ancestor filter from BaseHarnessFilters that isn't in that documentation.

I guess superclasses/inheritance isn't parsed when generating this doc?

@jelbourn jelbourn added area: dgeni Issue related to API docs extraction P2 The issue is important to a large percentage of users, with a workaround and removed needs triage This issue needs to be triaged by the team labels Aug 13, 2020
@jelbourn
Copy link
Member

@devversion do we extract API docs for static methods?

crisbeto added a commit to crisbeto/material2 that referenced this issue May 25, 2021
Exposes information about static members/properties in the API docs.

Fixes angular#20270.
@crisbeto crisbeto self-assigned this May 25, 2021
crisbeto added a commit to crisbeto/material2 that referenced this issue May 25, 2021
Exposes information about static members/properties in the API docs.

Fixes angular#20270.
wagnermaciel pushed a commit that referenced this issue May 25, 2021
Exposes information about static members/properties in the API docs.

Fixes #20270.
wagnermaciel pushed a commit that referenced this issue May 25, 2021
Exposes information about static members/properties in the API docs.

Fixes #20270.

(cherry picked from commit a48f736)
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Jun 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area: dgeni Issue related to API docs extraction docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants