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.

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

chore: update tsdocs of pricing module #5648

Merged
merged 4 commits into from
Nov 21, 2023
Merged

chore: update tsdocs of pricing module #5648

merged 4 commits into from
Nov 21, 2023

Conversation

shahednasser
Copy link
Member

  • Add TSDocs to new interfaces/methods
  • Update existing TSDocs by moving @prop descriptions to the level of each property of an interface.

@riqwan I've added some comments using the @privateRemarks tag, similar to last time.

@shahednasser shahednasser requested a review from a team as a code owner November 16, 2023 18:08
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 16, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 9eeed0c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Nov 16, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2023 10:47am
docs-ui ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2023 10:47am
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2023 10:47am

@shahednasser shahednasser requested a review from riqwan November 16, 2023 18:09
riqwan
riqwan approved these changes Nov 21, 2023
View reviewed changes
Copy link
Contributor

@riqwan riqwan left a comment

Choose a reason for hiding this comment

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

Lgtm! 🔥

packages/types/src/pricing/common/price-rule.ts
rule_type: RuleTypeDTO
/**
* @ignore
* @privateRemark
* @privateRemarks
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would be best to remove this from the types altogether.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure I should do it in this PR though, right? 😄

Copy link
Contributor

Choose a reason for hiding this comment

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

oh no, i've opened a PR for it - #5664

packages/types/src/pricing/common/money-amount.ts Show resolved Hide resolved
@shahednasser shahednasser merged commit fd27bc0 into develop Nov 21, 2023
12 checks passed
@shahednasser shahednasser deleted the chore/update-pricing-tsdocs branch November 21, 2023 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@riqwan riqwan riqwan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shahednasser @riqwan