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

Documenting the generated methods copyWith and toJson #1068

Open
rekire opened this issue Apr 11, 2024 · 2 comments · May be fixed by #1069
Open

Documenting the generated methods copyWith and toJson #1068

rekire opened this issue Apr 11, 2024 · 2 comments · May be fixed by #1069
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@rekire
Copy link

rekire commented Apr 11, 2024

I'm finishing my first flutter plugin where I am using freezed for some data classes. My problem is just that pub.dev marks that I did't document the copyWith and toJson methods. I would like to do that without modifying the generated files.

I would like to see that this part is auto generated or that you give me an option to set that e.g. in a annotation.

@rrousselGit
Copy link
Owner

Fancy making a PR? This should just be about adding docs directly in the generated code.

@rrousselGit rrousselGit added good first issue Good for newcomers and removed needs triage labels Apr 12, 2024
@rekire
Copy link
Author

rekire commented Apr 12, 2024

What do you prefer? Just generating the comment is good enough for me. I'll try to find the relevant code now

@rekire rekire linked a pull request Apr 12, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants