Skip to content

docs(cdk/testing): document TestElement methods #21103

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

Merged
merged 1 commit into from
Dec 1, 2020
Merged

docs(cdk/testing): document TestElement methods #21103

merged 1 commit into from
Dec 1, 2020

Conversation

yjaaidi
Copy link
Contributor

@yjaaidi yjaaidi commented Nov 20, 2020

Add missing documentation for freshly added methods: setInputValue, selectOptions & dispatchEvent.

Add missing documentation for freshly added methods: `setInputValue`, `selectOptions` & `dispatchEvent`.
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Nov 20, 2020
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes are fine, but I'm wondering whether we should be listing the methods out like this since the file is bound to go out of sync again. WDYT @mmalerba?

@yjaaidi
Copy link
Contributor Author

yjaaidi commented Nov 20, 2020

Thanks @crisbeto. You are right!
What about a link to something like https://material.angular.io/api/cdk/testing/TestElement. How is https://angular.io/api generated?

@crisbeto
Copy link
Member

The rest of the docs are generated from the source, but I'm not sure why TestElement isn't showing up.

@mmalerba
Copy link
Contributor

We do have a page that lists the API: https://material.angular.io/cdk/test-harnesses/api#TestElement maybe we can link to that instead

@yjaaidi
Copy link
Contributor Author

yjaaidi commented Nov 25, 2020

Good idea @mmalerba . Maybe we should also link to HarnessEnvironemnt API etc... and remove all the API tables.

@mmalerba mmalerba added action: merge The PR is ready for merge by the caretaker merge safe target: patch This PR is targeted for the next patch release labels Dec 1, 2020
@mmalerba mmalerba merged commit 2d9a656 into angular:master Dec 1, 2020
mmalerba pushed a commit that referenced this pull request Dec 1, 2020
Add missing documentation for freshly added methods: `setInputValue`, `selectOptions` & `dispatchEvent`.

(cherry picked from commit 2d9a656)
@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 Jan 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants