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

Demonstrate state as optional in controller guidelines #4910

Merged
merged 2 commits into from
Nov 30, 2024

Conversation

mcmire
Copy link
Contributor

@mcmire mcmire commented Nov 8, 2024

Explanation

In various examples in the controller guidelines, the state controller option was not optional, even though there is a guideline that says it should be. This commit updates the documentation so that it shown as optional.

References

I discovered that the examples were incorrect when reviewing this PR.

Changelog

N/A

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@mcmire mcmire requested a review from a team as a code owner November 8, 2024 20:11
@mcmire mcmire requested a review from a team November 8, 2024 20:12
In various examples in the controller guidelines, the `state` controller
option was not optional, even though there is a guideline that says it
should be. This commit updates the documentation so that it shown as
optional.
@mcmire mcmire force-pushed the update-controller-guidelines branch from 9dc039c to 1043096 Compare November 27, 2024 22:17
@mcmire mcmire self-assigned this Nov 27, 2024
@mcmire mcmire enabled auto-merge (squash) November 30, 2024 19:54
@mcmire mcmire merged commit f11ea90 into main Nov 30, 2024
120 checks passed
@mcmire mcmire deleted the update-controller-guidelines branch November 30, 2024 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants