mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-06-07 23:16:53 +00:00
Updated documentation tool (#155)
* Updated documentation tool Added templates Updated documentation using tool * Fixed incorrect version in web README * Added new templates to tool. Updated documents in templates across the code base. Used tool to regenerate documentation.
This commit is contained in:
committed by
Adrian Gallagher
parent
aaf9f52a70
commit
3b8591bcc8
23
tools/documentation/common_templates/common_readme.tmpl
Normal file
23
tools/documentation/common_templates/common_readme.tmpl
Normal file
@@ -0,0 +1,23 @@
|
||||
{{define "common" -}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
#### This package collates basic broad functions that are used throughout this codebase.
|
||||
|
||||
+ Coding example
|
||||
|
||||
```go
|
||||
import "github.com/thrasher-/gocryptotrader/common"
|
||||
|
||||
testString := "aAaAa"
|
||||
|
||||
upper := common.StringToUpper(testString)
|
||||
|
||||
// upper == "AAAAA"
|
||||
```
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations"}}
|
||||
{{end}}
|
||||
Reference in New Issue
Block a user