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

Clean up and Document io.image enhancements (#3034) #3193

Merged
merged 3 commits into from
Dec 20, 2020

Conversation

Sid2697
Copy link
Contributor

@Sid2697 Sid2697 commented Dec 19, 2020

Fixes #3034

  • I have not removed the documentation from decode_png and decode_jpg as docs in decode_image and read_image suggest the user to check decode_jpeg for the documentation. However, I have added the documentation to the enum.
  • Keeping the above note in mind, I have replaced old define with const.

I hope this PR solves all the aforementioned issues. Do let me know if there are any concerns.

…read_mode.h, replace define with const in image_read_mode.h, add documentation to ImageReadMode enum
@facebook-github-bot
Copy link

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!

@Sid2697 Sid2697 changed the title This PR fixes #3034 Fix #3034 Dec 19, 2020
@Sid2697 Sid2697 changed the title Fix #3034 Clean up and Document io.image enhancements (#3034) Dec 19, 2020
Copy link
Contributor

@datumbox datumbox left a 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.

@datumbox datumbox self-requested a review December 20, 2020 23:50
Copy link
Contributor

@datumbox datumbox left a 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!

@datumbox datumbox merged commit af5cb00 into pytorch:master Dec 20, 2020
@Sid2697 Sid2697 deleted the ioimage_cleanup_and_doc_enhancements branch December 20, 2020 23:56
facebook-github-bot pushed a commit that referenced this pull request Dec 23, 2020
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clean up and Document the io.image enhancements
3 participants