-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
chore(types): Add TSDoc comments to IInventoryService #5630
Conversation
shahednasser
commented
Nov 14, 2023
- Add TSDoc comments to the IInventoryService so that we can generate a reference later for the inventory module.
- Small fixes to the product module's TSDocs.
🦋 Changeset detectedLatest commit: 593f5fc The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Ignored Deployments
|
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.
lgtm, just a couple of nits
* @prop inventory_item_id - The ID of the associated inventory level. | ||
* @prop location_id - The ID of the associated location. |
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.
question: should we include stocked_quantity
and incoming_quantity
in this?
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.
It includes the TSDoc comments for them defined in UpdateInventoryLevelInput
by default.