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? #61

Open
hueitan opened this issue Sep 24, 2014 · 9 comments
Open

Documentation? #61

hueitan opened this issue Sep 24, 2014 · 9 comments
Labels

Comments

@hueitan
Copy link

hueitan commented Sep 24, 2014

Documentation?

@moshen
Copy link
Owner

moshen commented Sep 28, 2014

Right now there is practically none. The tests are very concise and should give you an idea on usage.

I'll leave this open because it is certainly an issue.

PRs including documentation would be appreciated.

@moshen moshen added the bug label Sep 28, 2014
@fabriziomoscon
Copy link
Collaborator

We could use this:
https://github.com/jsdoc3/jsdoc for doc blocks and see if we can generate a documentation for the public functions

@moshen
Copy link
Owner

moshen commented Mar 12, 2015

I like it 👍

@johnstew
Copy link

I wouldn't mind tackling some documentation for all the different API functions. This kind of already is being done on the README.md but might be best to create a new folder of examples that show each piece of functionality and how its designed to be used. Thoughts?

@mariomixtegapach
Copy link

Its possible to put style on a marker image?
Like scale and that stuffs?

@vikeen
Copy link

vikeen commented Dec 23, 2015

👍

Maybe something like https://github.com/swagger-api/swagger-ui would help reduce documentaiton overhead?

@vikeen
Copy link

vikeen commented Dec 23, 2015

@johnstew I think the tests cover examples pretty well. General documentation might solve both needs.

@hueitan
Copy link
Author

hueitan commented Dec 24, 2015

General documentation might solve both needs.

👍

@ntlzz93
Copy link

ntlzz93 commented Apr 22, 2016

Where's detail documentation for each function?

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

No branches or pull requests

7 participants