cmd/exchange_template: Update wrapper template, improve documentation (#2009)

* Updating wrapper template, updating documentation, regenerating documentation

* Renaming "streaming api" to "websocket"

* Context is now t

* Update docs/ADD_NEW_EXCHANGE.md

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>

* Update cmd/documentation/root_templates/root_readme.tmpl

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>

* Fixes an improper example and regenerates documentation

* Corrects typos

* Makes a table label consistent across files

---------

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>
This commit is contained in:
cranktakular
2025-11-11 11:07:26 +11:00
committed by GitHub
parent 6077707690
commit 2fd4f5ec5b
54 changed files with 145 additions and 146 deletions

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error

View File

@@ -5,7 +5,7 @@
[![Build Status](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/exchanges/Coinbase)
[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/exchanges/coinbase)
[![Coverage Status](https://codecov.io/gh/thrasher-corp/gocryptotrader/graph/badge.svg?token=41784B23TS)](https://codecov.io/gh/thrasher-corp/gocryptotrader)
[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := d.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := e.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := k.Trade(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := l.Trade(...)
if err != nil {
// Handle error

View File

@@ -111,7 +111,7 @@ if err != nil {
// Private calls - make sure your APIKEY and APISECRET are set and
// AuthenticatedAPISupport is set to true
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
orderID, err := ok.SubmitOrder(...)
if err != nil {
// Handle error

View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := p.PlaceOrder(...)
if err != nil {
// Handle error

View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error
}
// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := y.Trade("BTCUSD", "MARKET", 1, 2)
if err != nil {
// Handle error