Skip to content

docs: add missing documentation for error state properties #23010

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
Jun 22, 2021

Conversation

devversion
Copy link
Member

This is the first commit from #22875 so that we can fix the missing documentation without introducing a "technically" breaking change. The other PR will remain open for discussion & potentially for a new major if we agree on changing how stateChanges is defined.

All components relying on the `mixinErrorState` currently lack
descriptions for the mixin-defined properties. This commit adds
JSDoc descriptions for these properties. Also adds a small internal
note about why `stateChanges` is declared as part of the mixin.
@devversion devversion added docs This issue is related to documentation target: patch This PR is targeted for the next patch release labels Jun 18, 2021
@devversion devversion requested a review from crisbeto June 18, 2021 13:22
@devversion devversion requested a review from jelbourn as a code owner June 18, 2021 13:22
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jun 18, 2021
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.

LGTM

@devversion devversion added the action: merge The PR is ready for merge by the caretaker label Jun 18, 2021
@mmalerba mmalerba merged commit 136fb5a into angular:master Jun 22, 2021
mmalerba pushed a commit that referenced this pull request Jun 22, 2021
All components relying on the `mixinErrorState` currently lack
descriptions for the mixin-defined properties. This commit adds
JSDoc descriptions for these properties. Also adds a small internal
note about why `stateChanges` is declared as part of the mixin.

(cherry picked from commit 136fb5a)
mmalerba pushed a commit that referenced this pull request Jun 22, 2021
All components relying on the `mixinErrorState` currently lack
descriptions for the mixin-defined properties. This commit adds
JSDoc descriptions for these properties. Also adds a small internal
note about why `stateChanges` is declared as part of the mixin.

(cherry picked from commit 136fb5a)
@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 Jul 23, 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 docs This issue is related to documentation 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