node-googlemaps icon indicating copy to clipboard operation
node-googlemaps copied to clipboard
verified publisher icon moshen

Documentation?

Open hueitan opened this issue 11 years ago • 9 comments

Documentation?

hueitan avatar Sep 24 '14 02:09 hueitan

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 avatar Sep 28 '14 20:09 moshen

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

fabriziomoscon avatar Mar 10 '15 22:03 fabriziomoscon

I like it :+1:

moshen avatar Mar 12 '15 19:03 moshen

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?

johnstew avatar Sep 25 '15 20:09 johnstew

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

mariomixtegapach avatar Nov 18 '15 04:11 mariomixtegapach

:+1:

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

vikeen avatar Dec 23 '15 15:12 vikeen

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

vikeen avatar Dec 23 '15 15:12 vikeen

General documentation might solve both needs.

:+1:

hueitan avatar Dec 24 '15 03:12 hueitan

Where's detail documentation for each function?

ntlzz93 avatar Apr 22 '16 17:04 ntlzz93