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 of corruption function #9

Closed
ojwenzel opened this issue Oct 28, 2019 · 1 comment · Fixed by #10
Closed

documentation of corruption function #9

ojwenzel opened this issue Oct 28, 2019 · 1 comment · Fixed by #10
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ojwenzel
Copy link

When using the package I relied on the docstrings to the functions corruption. They do not seem to be up to date. 1) The function allows for arbitrary image width and height. 2) The function only accepts numpy arrays of dtype 'uint8'. Updated docstringt would be VERY helpful ;)

@Hvitgar Hvitgar added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 29, 2019
@Hvitgar
Copy link
Member

Hvitgar commented Oct 29, 2019

Thank you =)
I will update the docstring aswell as include a check that only arrays of type np.uint8 can be passed to the corrupt() function

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants