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 contextualized examples to the 'Pattern types' page #5425

Open
1 task
petro-i opened this issue Dec 22, 2023 · 1 comment
Open
1 task

Add contextualized examples to the 'Pattern types' page #5425

petro-i opened this issue Dec 22, 2023 · 1 comment
Assignees
Labels
a.language Relates to the Dart language tour dev.patterns Relates to the patterns language feature e3-weeks Complete in < 4 weeks of normal, not dedicated, work fix.examples Adds or changes example from.page-issue Reported in a reader-filed concern p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@petro-i
Copy link

petro-i commented Dec 22, 2023

Page URL

https://dart.dev/language/pattern-types

Page source

https://github.com/dart-lang/site-www/blob/main/src/content/language/pattern-types.md

Describe the problem

Pattern doc is very weak.
Examples are out of context, it is difficult to figure out real scenario of almost all of the patterns, for example "Logical-and" example looks 100% artificial and use-less.
Inline comments are missing for code examples.

Honestly, I used ChatGPT to convert such non-human doc to the doc average human can understand.

Expected fix

No response

Additional context

No response

I would like to fix this problem.

  • I will try and fix this problem on dart.dev.
@petro-i petro-i added the from.page-issue Reported in a reader-filed concern label Dec 22, 2023
@parlough parlough changed the title [PAGE ISSUE]: 'Pattern types' 'Pattern types' lacking contextualized examples Dec 22, 2023
@parlough parlough added a.language Relates to the Dart language tour p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e3-weeks Complete in < 4 weeks of normal, not dedicated, work dev.patterns Relates to the patterns language feature labels Dec 22, 2023
@parlough
Copy link
Member

Hi @petro-i, thanks for opening an issue and providing us with this feedback!

The goal of this page was to act as more of a quick reference for what types of patterns exist and their syntax, while the core Patterns page intends to be more like a guide with contextualized explanations.

We definitely can still improve both pages though, including with more comments, more realistic examples, etc. It's always a challenge to find a balance of conciseness and realism in examples, as they have different uses.

To help us determine some more concrete next steps, would you be able to point out some specific comments that would have helped, or perhaps an example you would like to see?

You mentioned ChatGPT provided you with some more helpful understanding. Could you share a specific example?

Thanks so much!

@atsansone atsansone changed the title 'Pattern types' lacking contextualized examples Add contextualized examples to the 'Pattern types' page Jan 23, 2024
@atsansone atsansone added the fix.examples Adds or changes example label Jan 23, 2024
@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.language Relates to the Dart language tour dev.patterns Relates to the patterns language feature e3-weeks Complete in < 4 weeks of normal, not dedicated, work fix.examples Adds or changes example from.page-issue Reported in a reader-filed concern p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

4 participants