stellar / new-docs

https://developers.stellar.org
MIT License
68 stars 133 forks source link

Create Passive Sell Offer in API docs has a wrong price description #688

Open ajpa-git opened 2 years ago

ajpa-git commented 2 years ago

What version are you using?

Stellar Protocol version: 19 Stellar API Reference https://developers.stellar.org/api/resources/operations/object/passive-sell-offer/

What did you do?

I was using the API reference to get to know the price I should write on a passive sell offer. When I compared it to the Stellar docs list of operations, it suggests to write the price as the inverse number of that: https://developers.stellar.org/docs/start/list-of-operations/#create-passive-sell-offer image

After executing a few operations in the testnet, I concluded that the API reference is wrong on its price explanation.

What did you expect to see?

In API reference: "Price of 1 unit of selling in terms of buying. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be 5 divided by 30"

What did you see instead?

In API reference: "How many units of selling_asset it takes to get 1 unit of buying_asset. A number representing the decimal form of price_r."

I hope this change helps other users of the API reference. Thanks!