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

Expand documentation #13

Closed
KnutZuidema opened this issue Jun 12, 2019 · 1 comment · Fixed by #14
Closed

Expand documentation #13

KnutZuidema opened this issue Jun 12, 2019 · 1 comment · Fixed by #14

Comments

@KnutZuidema
Copy link
Owner

Provide documentation describing the general use of each package
Provide documentation examples for all exported methods

@KnutZuidema
Copy link
Owner Author

KnutZuidema commented Jun 16, 2019

Providing examples for API methods requires an API key, and since that key should not be public, I can't add it as a plain string in the example and providing an example with usage of an environment variable does not seem useful to me, because it would mean, that those examples can not be used in the documentation. There will be integration tests in the future, decoupled from the documentation which may be used as examples for the usage of the API methods.
See #15

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

Successfully merging a pull request may close this issue.

1 participant