Skip to content

docs: Update DOCUMENTATION.md #1111

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

docs: Update DOCUMENTATION.md #1111

wants to merge 6 commits into from

Conversation

@teolemon
Copy link
Member

What

  • docs: Update DOCUMENTATION.md

@teolemon teolemon marked this pull request as ready for review July 15, 2025 10:13
@teolemon teolemon requested a review from a team as a code owner July 15, 2025 10:13
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
DOCUMENTATION.md
language: OpenFoodFactsLanguage.GERMAN,
fields: [ProductField.NAME]
);
final product = await OpenFoodAPIClient.getProductV3(conf);
Copy link
Member Author

Choose a reason for hiding this comment

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

to check

teolemon
teolemon commented Jul 15, 2025
View reviewed changes
DOCUMENTATION.md
// The requested language is German, so `product.productName`
// either is in German, or in main product's language, or null.
var name = product.productName ?? 'No name';
var name = product.product?.productName ?? 'No name';
Copy link
Member Author

Choose a reason for hiding this comment

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

to check

teolemon
teolemon commented Jul 15, 2025
View reviewed changes
DOCUMENTATION.md
// Erase not translated categories (e.g. "en:cake").
categories = categories.where((c) => !c.startsWith(RegExp('\w+:')));
// Erase not translated categories (e.g., "en:cake").
categories = categories?.where((c) => !c.startsWith(RegExp(r'\w+:'))).toList();
Copy link
Member Author

Choose a reason for hiding this comment

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

to check

teolemon
teolemon commented Jul 15, 2025
View reviewed changes
DOCUMENTATION.md
#### Updating German Product Categories

```dart
final conf = ProductQueryConfiguration(
Copy link
Member Author

Choose a reason for hiding this comment

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

to check

teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
teolemon
teolemon commented Jul 15, 2025
View reviewed changes
DOCUMENTATION.md
// The requested language is German, so `product.productName`
// either is in German, or in main product's language, or null.
var name = product.productName ?? 'No name';
var name = product.product?.productName ?? 'No name';
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
var name = product.product?.productName ?? 'No name';
var name = product.productName ?? 'No name';

teolemon
teolemon commented Jul 15, 2025
View reviewed changes
DOCUMENTATION.md
// Erase not translated categories (e.g. "en:cake").
categories = categories.where((c) => !c.startsWith(RegExp('\w+:')));
// Erase not translated categories (e.g., "en:cake").
categories = categories?.where((c) => !c.startsWith(RegExp(r'\w+:'))).toList();
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
categories = categories?.where((c) => !c.startsWith(RegExp(r'\w+:'))).toList();
categories = categories.where((c) => !c.startsWith(RegExp(r'\w+:'))

teolemon
teolemon commented Jul 15, 2025
View reviewed changes
DOCUMENTATION.md
// Set updated German categories AND avoid erasure of the not translated ones.
product.categoriesTagsInLanguages?[OpenFoodFactsLanguage.GERMAN] =
(updatedTranslatedCategories ?? []) + notTranslatedCategories;
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
(updatedTranslatedCategories ?? []) + notTranslatedCategories;
updatedCategories + notTranslatedCategories;

@teolemon teolemon moved this from 💬 To discuss and validate to Pull Requests in 🤳🥫 The Open Food Facts mobile app (Android & iOS) Jul 17, 2025
@teolemon teolemon moved this from Todo to In Progress in 🧃🛠️ Open Food Facts SDK tracking Aug 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@teolemon teolemon

Labels

📚 Documentation

Projects

Dart package - Support for new APIs and issues
Status: In progress
📚 Document Open Food Facts
Status: Todo
🤳🥫 The Open Food Facts mobile app (Android & iOS)
Status: Pull Requests
🧃🛠️ Open Food Facts SDK tracking
Status: In Progress

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@teolemon