d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-06-08 23:16:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Applied fix to documentation.go for contribution HTML_URL.

Browse Source 
Added period to documentation templates sentences.
Added logic to documentation.go to fix broken links for godoc in sub-packages.
Fix coding style to conform to golang idiomatic practice.
Applied fix to access main godocs in tools and test data.
Generated new documents using tools.
This commit is contained in:
Ryan O'Hara-Reid
2018-02-20 11:56:25 +11:00
parent 51755d214b
commit dd00eba27e
40 changed files with 148 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
tools/documentation/sub_templates/header.tmpl
View File

@@ -1,11 +1,11 @@
{{define "header" -}}
# GoCryptoTrader package {{.}}
# GoCryptoTrader package {{.Name}}
<img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
{{template "status" .}}
{{template "status" .NameURL}}
This {{.}} package is part of the GoCryptoTrader codebase
This {{.Name}} package is part of the GoCryptoTrader codebase.
## This is still in active development

2
tools/documentation/sub_templates/status.tmpl
View File

@@ -1,7 +1,7 @@
{{define "status"}}
[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader)
[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}})
{{with .}}[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}}){{else}}[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/){{end}}
[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
{{end}}