-
-
Notifications
You must be signed in to change notification settings - Fork 400
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
docs: explanation about packaging data #7517
Conversation
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.
I have some remarks. But overall it's ok.
docs/explanations/packaging-data.md
Outdated
|
||
### How the the resulting packagings data structure is created | ||
|
||
The values for each input field ("packaging" tag field and "packaging_text_[language code]" packaging information text field) are analyzed to recognize packaging components and their attributes. |
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.
Can you add a footnote on which is the corresponding function in ProductOpener ?
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.
Good idea, I added footnotes.
docs/explanations/packaging-data.md
Outdated
|
||
### How the the resulting packagings data structure is created | ||
|
||
The values for each input field ("packaging" tag field and "packaging_text_[language code]" packaging information text field) are analyzed to recognize packaging components and their attributes. |
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.
You don't explain how we deal with entries in more than one language. Do we analyze them all ?
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.
Currently we only analyze the entry corresponding to the main language of the product. Added a note about that.
docs/explanations/packaging-data.md
Outdated
|
||
It is important to keep this field, as we can display it as-is, use it as input data, and it may contain interesting data that we do not analyze yet. | ||
|
||
When filled, the values for this field can be analyzed and added to / combined with the "packagings" data structure. |
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.
Explain if there would be a round trip between this field and packaging_text_[language code].
That is if writing in packagings should affect packaging_text ?
Could we also keep a track of which characters (span) of packaging_text mapped to an entry in packagings ?
How do you deal with eventual parts of packaging_text that you are not able to parse ? Do you reject the input in this case ?
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.
Writing packagings will not affect packaging_text.
We can keep track of what part of the text was matched to what. What we don't recognize is ignored.
Added notes about that in the doc.
Kudos, SonarCloud Quality Gate passed! |
What
Part of