Skip to content

[packages] Adopt code-excerpt across all READMEs #102679

New issue
New issue
Open
Open
[packages] Adopt code-excerpt across all READMEs#102679
Labels
P2Important issues not at the top of the work listc: contributor-productivityTeam-specific productivity, code health, technical debt.d: api docsIssues with https://api.flutter.dev/packageflutter/packages repository. See also p: labels.team-ecosystemOwned by Ecosystem teamtriaged-ecosystemTriaged by Ecosystem team
@stuartmorgan-g

Description

@stuartmorgan-g
stuartmorgan-g
opened on Apr 27, 2022

flutter/plugins#5339 will add the ability to manage our README code snippets with code-excerpt so that they stop getting out of sync with changes in APIs, Dart, or lints, as well as sometimes just having typos that make them incorrect from the start. Once that lands we should start proactively updating all of our READMEs to use it, rather than waiting for bugs to be found, since it's a pretty easy change and will almost certainly find and fix latent issues in our READMEs given the steady stream of PRs we get about them.

That will also allow us to turn on enforcement in the repo to ensure that new code samples are written that way, so we don't create new documentation tech debt by accident.

Here's the list of exceptions we need to eliminate:

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Important issues not at the top of the work listc: contributor-productivityTeam-specific productivity, code health, technical debt.d: api docsIssues with https://api.flutter.dev/packageflutter/packages repository. See also p: labels.team-ecosystemOwned by Ecosystem teamtriaged-ecosystemTriaged by Ecosystem team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions