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.

Sign up for GitHub

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

Jump to bottom

Doctests #24

Open
obmarg opened this issue Feb 4, 2018 · 0 comments
Open

Doctests #24

obmarg opened this issue Feb 4, 2018 · 0 comments
Labels
documentation enhancement

Comments

@obmarg
Copy link
Owner

obmarg commented Feb 4, 2018 •
edited
Loading

Some public facing kazan functions could do with examples in their documentation. Ideally these should be in the form of doc tests so we can be sure they're correct.

This might involve writing a mock-client, mock k8s or using exvcr so that the tests can run without an actual k8s server.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@obmarg