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

io.Stdout.Encoding API Spec is incomplete #31651

Closed
iarkh opened this issue Dec 14, 2017 · 1 comment
Closed

io.Stdout.Encoding API Spec is incomplete #31651

iarkh opened this issue Dec 14, 2017 · 1 comment
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. docs-api library-io

Comments

@iarkh
Copy link
Contributor

iarkh commented Dec 14, 2017

Descriptio of io.Stdout.Encoding field in Dart API Spec is incomplete. See https://api.dartlang.org/stable/1.24.2/dart-io/Stdout/encoding.html.

Now it contains just a piece of the source code:

Source
Encoding get encoding => _sink.encoding;
void encoding=(
Encoding encoding
)
Source
void set encoding(Encoding encoding) {
  _sink.encoding = encoding;
}

It should contain a description and look like the one described for io.IOSink.encoding:
The Encoding used when writing strings. Depending on the underlying consumer this property might be mutable.

@floitschG floitschG added area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-io labels Dec 22, 2017
@natebosch
Copy link
Member

This class now picks up the doc from the implementation in IOSink. I don't know if there used to be a local @override that was causing the docs to get lost, or if there was a change in dartdoc. Either way, this documentation exists now.

https://api.dart.dev/stable/3.0.5/dart-io/Stdout/encoding.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. docs-api library-io
Projects
None yet
Development

No branches or pull requests

4 participants