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

Improve documentation #41

Open
HarelM opened this issue Jun 24, 2018 · 1 comment
Open

Improve documentation #41

HarelM opened this issue Jun 24, 2018 · 1 comment

Comments

@HarelM
Copy link

HarelM commented Jun 24, 2018

Hi,
First and foremost, thanks for this great library!
While I think the code is generally written well, I saw that in order to use this library I need to read it after reading the documentation as I didn't find what I was looking for in the documentation.
Furthermore, intellisense is not available and this too would be extremely helpful.
DefinitelyTyped is a project that is used to create intellisense to javascript libraries for TypeScript, which is currently used by Google and Microsoft.

A use case for example:
Get GPS coordinates from exif data.
The currently documentation only specify a method in the helper to write GPS coordinates, however, the code has the opposite method as well, but it can't be found in the docs and only looking at the code can reveal it.

@TomasHubelbauer
Copy link

Hey, the docs are hosted by ReadTheDocs which should be editable on GitHub. Would be cool for you to create a PR with the changes you would like to see, I am also looking for more examples, so any real world use cases you have figured out would be a great contribution to the docs for others to study.

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

2 participants