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

add ImmediateContainer, Quantity and SimplyUnit, clarify Unit use #1689

Open
wants to merge 14 commits into
base: 1.2-dev
Choose a base branch
from

Conversation

odscjen
Copy link
Contributor

@odscjen odscjen commented May 15, 2024

closes #1343

draft until comment is agreed upon

@jpmckinney
Copy link
Member

Just a couple comments on the Markdown. I'll review the schema when ready.

odscjen and others added 2 commits May 15, 2024 15:07
Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com>
@odscjen odscjen marked this pull request as ready for review May 15, 2024 14:23
@odscjen
Copy link
Contributor Author

odscjen commented May 15, 2024

Error
FAILED tests/test_schema_integrity.py::test_versioned_release_schema_is_in_sync - UserWarning: /definitions/Quantity/properties/value has unrecognized type ['string', 'number', 'null']

Quantity has been lifted straight from the medicine extension, I think the test may need updating

@odscjen odscjen requested a review from jpmckinney May 15, 2024 14:26
@jpmckinney
Copy link
Member

jpmckinney commented May 29, 2024

Noting that I'll correct a "agreeemnts" typo and update the profile template via this PR before merging.

@jpmckinney
Copy link
Member

I considered adding 'GDSN' to itemClassificationScheme.csv (similarly, we could add a code for the immediateContainer codelist from the medicine extension), but since we discourage units of presentation for the unit field, I think it makes sense to omit it.

…licates schema and that define unit of measurement. Remove instruction about QUDT that is difficult to follow due to QUDT's documentation structure. Don't collapse field that is defined by subschema.
Copy link
Member

@jpmckinney jpmckinney left a comment

Choose a reason for hiding this comment

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

I made edits as described in commit messages. @duncandewhurst You might want to review commits individually, skipping the chore and ci commits.

@duncandewhurst
Copy link
Contributor

I reviewed the individual commits and ran the pre-commit script to update the dereferenced release schema so that I could review the HTML documentation.

The changes look good, but the first sentence of the descriptions of Item.unit and Item.immediateContainer simply restate the title of the fields. Perhaps they could be improved? e.g.

  • .unit: "The pricing unit" -> "The unit in which the pricing of the items is specified"
  • .immediateContainer: "The immediate container for the item" -> "The innermost container in which the items are packaged"

Anyway, happy for you to merge if you think the descriptions are OK as-is.

@jpmckinney
Copy link
Member

Good call - I'll reword to be more informative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify unit description
3 participants