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

Add documentation for the ESLint rule signal-state-no-arrays-at-root-level #4501

Closed
2 tasks
timdeschryver opened this issue Aug 21, 2024 · 0 comments · Fixed by #4549
Closed
2 tasks

Add documentation for the ESLint rule signal-state-no-arrays-at-root-level #4501

timdeschryver opened this issue Aug 21, 2024 · 0 comments · Fixed by #4549

Comments

@timdeschryver
Copy link
Member

Information

The rule signal-state-no-arrays-at-root-level should be documented at https://github.com/ngrx/platform/blob/main/projects/ngrx.io/content/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.md.

It should also contain one or more examples showcasing some "bad" and "good" snippets.
For some examples we can take a look at the test cases at https://github.com/ngrx/platform/blob/main/modules/eslint-plugin/spec/rules/signals/with-state-no-arrays-at-root-level.spec.ts.

Documentation page

https://ngrx.io/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level

I would be willing to submit a PR to fix this issue

  • Yes
  • No
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant