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

Update storybook-interactions-play-function.md #30375

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

kirjs
Copy link
Contributor

@kirjs kirjs commented Jan 24, 2025

Replace onSubmit -> submit, and mention it's an output to make things more angulary

https://angular.dev/style-guide#dont-prefix-output-properties

This is purely docs change and shouldn't affect anything outside

Greptile Summary

Updates documentation to align with Angular's style guide by replacing 'onSubmit' with 'submit' for output properties, but introduces inconsistencies in property naming across examples.

  • Inconsistent property naming in docs/_snippets/storybook-interactions-play-function.md where 'onSubmit' and 'submit' are used interchangeably
  • Property name 'onSubmit' still appears in play function assertions and non-Angular framework examples
  • Need to standardize property naming across all code examples to maintain consistency with Angular style guide
  • Consider adding a note about framework-specific naming conventions if different patterns are intentional

💡 (2/5) Greptile learns from your feedback when you react with 👍/👎!

Replace onSubmit -> submit, and mention it's an output to make things more angulary

https://angular.dev/style-guide#dont-prefix-output-properties
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

@@ -8,8 +8,8 @@ import { Form } from './Form.component';
const meta: Meta<Form> = {
component: MyComponent,
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: MyComponent is used here but Form is imported. This appears to be a typo.

Comment on lines +11 to +12
// 👇 Use `fn` to spy on the submit output
submit: fn(),
Copy link
Contributor

Choose a reason for hiding this comment

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

style: This change to 'submit' is only made in the Angular example but not in other framework examples. Consider whether this should be consistent across all frameworks or if it should be explicitly noted as Angular-specific.

@jonniebigodes jonniebigodes self-assigned this Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants