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

Update documentation to describe what method params do #174

Open
TytaniumDev opened this issue Oct 14, 2019 · 4 comments
Open

Update documentation to describe what method params do #174

TytaniumDev opened this issue Oct 14, 2019 · 4 comments
Assignees

Comments

@TytaniumDev
Copy link

I've noticed that a lot of the methods in the generated Dart API docs for Flare-Flutter don't have descriptions about what the parameters actually do. Example: https://pub.dev/documentation/flare_dart/latest/animation_actor_animation/ActorAnimation/apply.html

I had to find the actual documentation for apply in a medium post: https://medium.com/2dimensions/building-a-responsive-house-with-flare-flutter-31af823ba805

The description in the Medium post is excellent, it would be great to put those descriptions directly in the dart docs!

I've noticed this in other places in the docs as well, it'd be good to do an audit?

@jkurtw
Copy link
Collaborator

jkurtw commented Oct 14, 2019

/cc @luigi-rosso

@luigi-rosso
Copy link
Contributor

We're working on this!

@she-who-codes
Copy link

We recently published our Runtime Manual here. We are continuing to build on it, but it's consolidated a lot of the information we had spread about in our tutorials.

@luigi-rosso
Copy link
Contributor

Let's keep this issue open to specifically track the Dart API documentation in Flare-Flutter! We still have a long way to go there.

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

5 participants