Skip to content

dart:io APPEND field should be marked as const in Dart API Spec #31697

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

Closed
iarkh opened this issue Dec 20, 2017 · 2 comments
Closed

dart:io APPEND field should be marked as const in Dart API Spec #31697

iarkh opened this issue Dec 20, 2017 · 2 comments

Comments

@iarkh
Copy link
Contributor

iarkh commented Dec 20, 2017

dart:io APPEND Spec reads:

APPEND = FileMode.APPEND
The mode for opening a file for reading and writing to the end of it. The file is created if it does not already exist.

It should be marked as const because actually it's a constant and cannot be changed.
So, description should look loke one for FileMode.APPEND field:
dynamic APPEND = **const** FileMode._internal(2)
See here: https://api.dartlang.org/stable/1.24.3/dart-io/APPEND-constant.html

Some other fields from dart:io Constants section in the Spec are also not marked const: READ, WRITE, WRITE_ONLY, WRITE_ONLY_APPEND.

@floitschG
Copy link
Contributor

Marking as a dartdoc issue.
The constant itself is const.

const APPEND = FileMode.APPEND;

The const in front of it makes the variable constant.
However, dartdoc doesn't show this in the documentation.

@floitschG
Copy link
Contributor

This issue was moved to dart-lang/dartdoc#1576

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants