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

[3.2] Add code excerpts to non-promotion-reasons #5350

Open
MaryaBelanger opened this issue Nov 14, 2023 · 1 comment · May be fixed by #5359
Open

[3.2] Add code excerpts to non-promotion-reasons #5350

MaryaBelanger opened this issue Nov 14, 2023 · 1 comment · May be fixed by #5359
Assignees
@MaryaBelanger
Labels
e2-days Can complete in < 5 days of normal, not dedicated, work fix.examples Adds or changes example fix.refactor Needs near total rewrite or reorganization of content p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@MaryaBelanger
Copy link
Contributor

Lots of new code examples in #5246, should convert them all to code excerpts.

  • {:.bad} snippets don't get an excerpt (just going to cause errors)
  • Right now, all the examples share generic class names and field names... there might be a way to section off the code for the snippets but we're either going to have to change a lot of the identifiers to fit them in the same file, or make a few new files. TBD
@MaryaBelanger MaryaBelanger self-assigned this Nov 14, 2023
@atsansone atsansone added p2-medium Necessary but not urgent concern. Resolve when possible. fix.examples Adds or changes example e2-days Can complete in < 5 days of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content st.triage.ltw Indicates Lead Tech Writer has triaged labels Nov 14, 2023
@parlough
Copy link
Member

{:.bad} snippets don't get an excerpt (just going to cause errors)

Sometimes this is what we want as we can confirm code we expect to get an error actually has an error. Just like we confirm that code we want to be valid, is valid.

Right now, all the examples share generic class names and field names.

There's lots of ways to solve this from nesting where possible, different files, or replace instructions on the code excerpts.

@MaryaBelanger MaryaBelanger linked a pull request Nov 17, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MaryaBelanger MaryaBelanger

Labels
e2-days Can complete in < 5 days of normal, not dedicated, work fix.examples Adds or changes example fix.refactor Needs near total rewrite or reorganization of content p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add code excerpts to new type promotion failures dart-lang/site-www
3 participants
@atsansone @parlough @MaryaBelanger