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

Documentation isn't complete enough #15

Open
pbwauyo opened this issue Oct 17, 2020 · 5 comments
Open

Documentation isn't complete enough #15

pbwauyo opened this issue Oct 17, 2020 · 5 comments
Labels
question Further information is requested

Comments

@pbwauyo
Copy link

pbwauyo commented Oct 17, 2020

The usage documentation needs serious improvement. Its very poor and uncoordinated. Very hard to follow. Also the examples are very poor.

@aloisdeniel
Copy link
Owner

The example looks pretty complete to me, I even built an entire UI example.

What would you like in the documentation ? Maybe add a quickstart example with all functions used together ?

@aloisdeniel aloisdeniel added the question Further information is requested label Oct 19, 2020
@pbwauyo
Copy link
Author

pbwauyo commented Oct 20, 2020

for example this is a snippet from your docs:

final MediaPage imagePage = await widget.collection.getMedias(
    mediaType: MediaType.image,
    take: 500,
);

but no definition of the type of widget.collection

and also from another snippet:

MediaCollections collections = await MediaGallery.listMediaCollections(
    mediaTypes: [MediaType.image, MediaType.video],
);

and the type MediaCollections doesnt seem to exist in the library.
Generally the examples are overly complicated and confusing.
I wish the examples were more orderly and chronological.

@aloisdeniel
Copy link
Owner

Okay thanks for the feedbacks.

@aloisdeniel aloisdeniel changed the title Poor Documentation Documentation isn't complete enough Oct 21, 2020
@BSiddharth
Copy link

Yes really Documentation needs some improvement. After reading for 5 minutes I still don't get what does your package do? You have made an example but if I had to write all that , why am I using this. I thought this package do all that stuff for me.
Like doing something like ShowGallery( take :50, mediaType: MediaType.image,) and this will do the work which was shown in the picture

image

@jorjyeah
Copy link

for example this is a snippet from your docs:

final MediaPage imagePage = await widget.collection.getMedias(
    mediaType: MediaType.image,
    take: 500,
);

but no definition of the type of widget.collection

and also from another snippet:

MediaCollections collections = await MediaGallery.listMediaCollections(
    mediaTypes: [MediaType.image, MediaType.video],
);

and the type MediaCollections doesnt seem to exist in the library.
Generally the examples are overly complicated and confusing.
I wish the examples were more orderly and chronological.

So, where are the complete documentations? I'm still get confused every time I read the "example" project.

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

No branches or pull requests

4 participants