-
Notifications
You must be signed in to change notification settings - Fork 7k
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
Clean up and Document io.image enhancements (#3034) #3193
Clean up and Document io.image enhancements (#3034) #3193
Conversation
…read_mode.h, replace define with const in image_read_mode.h, add documentation to ImageReadMode enum
Hi @Sid2697! Thank you for your pull request. We require contributors to sign our Contributor License Agreement, and yours needs attention. You currently have a record in our system, but we do not have a signature on file. In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! I left a few comments, let me know what you think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Sid2697 LGTM, thank you!
Summary: * Update ImageReadMode error messages, add newline at the end of image_read_mode.h, replace define with const in image_read_mode.h, add documentation to ImageReadMode enum * Update readpng_cpu and readjpeg_cpu error messages * Update image.py documentation Reviewed By: fmassa Differential Revision: D25679209 fbshipit-source-id: 4376dbb0e005ae4a09b908daada8a5a5cfd9b2a8
Fixes #3034
decode_png
anddecode_jpg
as docs indecode_image
andread_image
suggest the user to checkdecode_jpeg
for the documentation. However, I have added the documentation to the enum.const
.I hope this PR solves all the aforementioned issues. Do let me know if there are any concerns.