Skip to content

Remove "in checked mode" from documentation. #21066

Closed

Description

@gspencergoog

From @jacob314 : "In the Flutter doc comments there are a lot of comments that start with "In checked mode" which should probably be updated to be consistent with Dart 2.
Dart 2 doesn't have a concept of checked vs unchecked mode. In Dart 1, unchecked mode meant ignore all type checks as well as ignore asserts.
In Dart2, --enable-asserts turns on asserts which is technically correct for these comments but a bit of a mouthful."

We should update any doc comments that reference "checked mode" with something appropriate.

Activity

  1. eernstg commented on Aug 27, 2018

    @eernstg
    Contributor

    I'd say that any reference to checked mode that is concerned with a user-written assert statement should refer to --enable-asserts, and all other references to checked mode should be removed, because the topic would then be checks added implicitly in checked mode with Dart 1, and those checks are always added to the program in Dart 2 (except maybe any such checks where we can prove at compile-time that they will always succeed, so it makes no difference to omit them), so we just stop talking about any particular mode, and keep the rest of the text unchanged.

  2. added this to the milestone on Aug 27, 2018
  3. Sfshaza commented on Aug 28, 2018

    @Sfshaza

    In case someone wants to review (@gspencergoog, @eernstg), here's the short PR: flutter/website#1191

    Checked mode wasn't used much on flutter.io. It may be used more on docs.flutter.io.

  4. eernstg commented on Aug 28, 2018

    @eernstg
    Contributor

    I just added a single comment about the description of assert statements.

  5. added
    frameworkflutter/packages/flutter repository. See also f: labels.
    c: API breakBackwards-incompatible API changes
    on Dec 7, 2018
  6. added
    P2Important issues not at the top of the work list
    on May 29, 2020
  7. removed this from the milestone on Aug 17, 2020
  8. self-assigned this
    on Apr 16, 2024
  9. github-actions commented on Apr 30, 2024

    @github-actions

    This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

  10. locked as resolved and limited conversation to collaborators on Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P2Important issues not at the top of the work listc: API breakBackwards-incompatible API changesd: api docsIssues with https://api.flutter.dev/frameworkflutter/packages/flutter repository. See also f: labels.team-frameworkOwned by Framework teamtriaged-frameworkTriaged by Framework team

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions