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.

Sign up for GitHub

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

Jump to bottom

Make dartdoc examples self-contained. #101

Open
sigurdm opened this issue May 2, 2024 · 1 comment
Open

Make dartdoc examples self-contained. #101

sigurdm opened this issue May 2, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@sigurdm
Copy link
Collaborator

sigurdm commented May 2, 2024

The code in dartdoc examples mixes imports and statement-level code.

Ideally it would contain self-contained code that one could copy and run for one-self. And that we could extract programmatically and format, analyze etc.
@sigurdm sigurdm mentioned this issue May 2, 2024
Merged
@HamdaanAliQuatil HamdaanAliQuatil mentioned this issue May 5, 2024
Merged
2 tasks
@jonasfj jonasfj added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels May 6, 2024
@jonasfj
Copy link
Member

jonasfj commented May 6, 2024

Yeah, adding Future<void> main() async { around the actual statement-level code won't hurt readability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jonasfj @sigurdm