Skip to content

docs: add image addition documentation and examples#447

Closed
techakash32 wants to merge 2 commits intoopenfoodfacts:developfrom
techakash32:fix-issue-55
Closed

docs: add image addition documentation and examples#447
techakash32 wants to merge 2 commits intoopenfoodfacts:developfrom
techakash32:fix-issue-55

Conversation

@techakash32
Copy link

Description

  • Issue Document image addition #55 requested documentation for the image addition
    feature in the Python SDK. The add_image method existed
    in the codebase but had no documentation or usage examples.

Solution

  • Added a new ### Add an image to a product section in
    docs/usage.md with:

    • Basic usage example with authentication
    • All supported image_field values explained
    • Language suffix examples (e.g. front_en, ingredients_fr)
    • Multiple image upload example
    • Image requirements (licence, minimum size)
    • Staging environment tip for testing
  • Updated README.md with:

    • Added Upload images to a product in the description bullets
    • Added a short add_image example in the Examples section

Related issue(s)

@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 3, 2026

@techakash32
Copy link
Author

Hi @teolemon!

I've opened this PR to address issue #55 — documenting the image addition feature in the Python SDK.

Here's a summary of what I've changed:

  • Added a new ### Add an image to a product section in docs/usage.md with usage examples, supported image fields, language suffixes, and image requirements.
  • Updated README.md to include add_image in the description and examples section.

Since you originally opened issue #55, could you please review the changes and let me know if anything needs to be corrected or improved? I want to make sure everything accurately reflects the actual API behavior.

Thank you!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using AI and then committing unrelated files without checking is direspectful of reviewer time

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for committing unrelated files and relying on AI without properly reviewing the changes. I’ll make sure to check my commits carefully before pushing in the future.

@techakash32 techakash32 closed this by deleting the head repository Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Document image addition

2 participants