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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

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. It also clarifies the examples to use real names instead of "dummy" names.

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

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. It also clarifies the examples to use real names instead of
"dummy" names.
@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
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.

1 participant