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

Package dart:io should document exceptions #44487

Open
weenzeel opened this issue Dec 16, 2020 · 1 comment
Open

Package dart:io should document exceptions #44487

weenzeel opened this issue Dec 16, 2020 · 1 comment
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-io type-documentation A request to add or improve documentation

Comments

@weenzeel
Copy link

Hi!

The package dart:io should document exceptions thrown.

E.g. The exception thrown by the code bellow isn't mentioned in documentation comments, and aren't discoverable by looking at the dart implementation of the methods used.

import 'dart:io';

...
var dir = Directory('/Users/Path/To/Folder/That/Dosent/Exist/');
var entityList = dir.listSync(recursive: true, followLinks: false);
...

Thanks

Dart SDK version: 2.10.4 (stable)
MacOS

@lrhn lrhn added area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-io type-documentation A request to add or improve documentation labels Dec 16, 2020
@mleonhard
Copy link

I need to know if dart:io:HttpClientRequest.abort throws exceptions. I wasted several minutes searching and finally found the actual code of the function in sdk/lib/_http/http_impl.dart . It appears to not throw.

The Dart & Flutter documentation is incomplete. Dart Team & Flutter Team, please please please finish the documentation. It won't get you promoted and earn you more money, but it's really important to us, your users. CC: @timsneath (Flutter PM)

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. library-io type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

3 participants