openfoodfacts / openfoodfacts-server

Open Food Facts database, API server and web interface - 🐪🦋 Perl, CSS and JS coders welcome 😊 For helping in Python, see Robotoff or taxonomy-editor
http://openfoodfacts.github.io/openfoodfacts-server/
GNU Affero General Public License v3.0
645 stars 374 forks source link

Clearer verbiage for Edit Product field (Affects US users) #8285

Open zanovis opened 1 year ago

zanovis commented 1 year ago

What

Example

The current 'Quantity' field is for the product's total mass (if solid) or volume (if liquid). Quantity intuitively seems like the discrete amount of the products in the package, so if you have candy with 2 pieces, quantity would be '2 pieces'.

In the US, we call this value 'Net Weight' and have 'oz'/'g'/'fl oz'/'mL'. image image

Current edit product field name: 'Quantity' (API: product_quantity) image

Proposed US-based edit product field name: 'Net Weight/Volume' (I understand 'weight' is a misnomer, since products display the value in 'oz' AND 'g', but this would make it match US product labels 1:1) image

To Reproduce

View a product's edit page

Expected behavior

A US user expects to see field titles that match the product's field names on the label.

Additional context

I believe this change would make users more likely to enter this data and it would also improve the reliability of this data because there would be less confusion about if this is 'serving size' vs 'total mass'.

Number of products impacted

aleene commented 1 year ago

The quantity field does not to seem to be processed and normalised. I could not find a normalised entry in the json.

It shoudl also be possible to add the number of servings in this field as well (some extra parsing).

See also: https://wiki.openfoodfacts.org/Products_quantities

stephanegigandet commented 1 year ago

@aleene The "quantity" field is a text field, it is normalized in the "product_quantity" field (which is either in g or in ml). e.g. https://world.openfoodfacts.org/api/v3/product/3033490004521?fields=quantity,product_quantity

product_quantity: "500",
quantity: "500 g (4 × 125 g)"

@zanovis We could rename the "Quantity" field in "Quantity (Net weight or volume)". Making the name specific to countries would be difficult to maintain.

aleene commented 1 year ago

@stephanegigandet thanks, not sure why I missed that. Might the field be left out sometimes?

github-actions[bot] commented 1 year ago

This issue is stale because it has been open 90 days with no activity.

github-actions[bot] commented 10 months ago

This issue has been open 90 days with no activity. Can you give it a little love by linking it to a parent issue, adding relevant labels and projets, creating a mockup if applicable, adding code pointers from https://github.com/openfoodfacts/openfoodfacts-server/blob/main/.github/labeler.yml, giving it a priority, editing the original issue to have a more comprehensive description… Thank you very much for your contribution to 🍊 Open Food Facts