Skip to content
This repository has been archived by the owner on Jan 12, 2022. It is now read-only.

fix: create transaction recipient documentation #180

Merged
merged 2 commits into from
Sep 1, 2020
Merged

Conversation

Alex-Werner
Copy link
Contributor

Issue being fixed or feature implemented

When creating a transaction with a unique recipient, two parameters will need to be passed :

  • recipient, a PublicAddress
  • satoshis or amount, a number.

In our documentation we were referring to Recipient as a single object having an address, satoshis/amount.

This PR fixes that documentation issue.

What was done?

  • modified Account.d.ts to refer to the correct usage
  • verified /docs/Account/createTransaction correctness

How Has This Been Tested?

No code change.

Breaking Changes

N/A

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

@Alex-Werner Alex-Werner added this to the v0.15 milestone Aug 27, 2020
@Alex-Werner Alex-Werner requested a review from thephez August 28, 2020 20:08
Copy link
Contributor

@thephez thephez left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Member

@shumkov shumkov left a comment

Choose a reason for hiding this comment

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

👍

@shumkov shumkov merged commit e80d573 into v0.15-dev Sep 1, 2020
@shumkov shumkov deleted the fix/createTx-doc branch September 1, 2020 14:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants