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

[file_selector] Improve API docs and examples #97011

Closed
stuartmorgan opened this issue Jan 21, 2022 · 8 comments · Fixed by flutter/plugins#4824
Closed

[file_selector] Improve API docs and examples #97011

stuartmorgan opened this issue Jan 21, 2022 · 8 comments · Fixed by flutter/plugins#4824
Labels
p: file_selector The file_selector plugin P1 High-priority issues at the top of the work list package flutter/packages repository. See also p: labels.

Comments

@stuartmorgan
Copy link
Contributor

The API docs for file_selector are extremely thin right now; they are pretty much just the one-sentence summary, with no explanation of parameters or edge cases (e.g., what a null return means). We also don't show examples of most of the parameters in the example app.

(/cc @ditman)

@stuartmorgan stuartmorgan added plugin P1 High-priority issues at the top of the work list p: file_selector The file_selector plugin labels Jan 21, 2022
@ditman ditman added this to Not Started in Flutter Web Plugins via automation Jan 31, 2022
@TowaYamashita
Copy link
Contributor

Hello. @ditman
I am interested in this issue because I have some experience using file_selector in my work.
So, I would like to work on this issue.
If at all possible, could you please assign this issue to me?
I'm not very good at English, so I'm worried if I'm expressing myself in a way that might offend you.
However, I will work diligently on the issue and I hope you will consider it.

@stuartmorgan
Copy link
Contributor Author

You don't need to have the issue assigned to you to work on it; feel free to submit a PR with improvements.

@TowaYamashita
Copy link
Contributor

@stuartmorgan
thanks, I will try it;

@ditman
Copy link
Member

ditman commented Feb 7, 2022

Thank you very much for your contribution @TowaYamashita! Looking forward to it!

@TowaYamashita
Copy link
Contributor

Hi, @ditman
Could you please do code review?
I've added some comments about file_selector, but it would be nice if you could take a look at it to see if it's worded in a confusing way.

@ditman
Copy link
Member

ditman commented Feb 18, 2022

Thanks @TowaYamashita! I hadn't noticed your PR! @stuartmorgan has already assigned himself there, so he's probably going to review it soon! I'll take a quick look too!

Thanks for the contribution!

@TowaYamashita
Copy link
Contributor

@ditman @stuartmorgan

Sorry for the delay in responding to your comment. 🙇
I planning on updating this PR .
I am currently modifying the code.

I do apologize for any inconvenience caused. 🙇

Flutter Web Plugins automation moved this from Not Started to Done Jun 9, 2022
@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 23, 2022
@flutter-triage-bot flutter-triage-bot bot added the package flutter/packages repository. See also p: labels. label Jul 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
p: file_selector The file_selector plugin P1 High-priority issues at the top of the work list package flutter/packages repository. See also p: labels.
Projects
Development

Successfully merging a pull request may close this issue.

3 participants