Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add .gomarkdoc.yml and update docs #173

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Add .gomarkdoc.yml and update docs #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gomarkdoc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
excludeDirs: "./cmd/..."
output: "{{.Dir}}/README.md"
repository:
url: https://github.com/cinar/indicator
Copy link
Contributor Author

@sunglim sunglim Jul 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

repository.url is necessary for forked repository! Otherwise, in my forked repository, the docs becomes like this.

 <a name="Ad"></a>
-## type [Ad](<https://github.com/cinar/indicator/blob/master/volume/ad.go#L20-L23>)
+## type [Ad](<https://github.com/sunglim/indicator/blob/master/volume/ad.go#L20-L23>)

29 changes: 21 additions & 8 deletions helper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,15 @@ const (
)
```

<a name="DefaultReportDateFormat"></a>

```go
const (
// DefaultReportDateFormat is the default date format used in the report.
DefaultReportDateFormat = "2006-01-02"
)
```

<a name="Abs"></a>
## func [Abs](<https://github.com/cinar/indicator/blob/master/helper/abs.go#L15>)

Expand Down Expand Up @@ -1041,20 +1050,24 @@ type Number interface {
```

<a name="Report"></a>
## type [Report](<https://github.com/cinar/indicator/blob/master/helper/report.go#L53-L55>)
## type [Report](<https://github.com/cinar/indicator/blob/master/helper/report.go#L48-L54>)

Report generates an HTML file containing an interactive chart that visually represents the provided data and annotations.

The generated HTML file can be opened in a web browser to explore the data visually, interact with the chart elements, and view the associated annotations.

```go
type Report struct {
// contains filtered or unexported fields
Title string
Date <-chan time.Time
Columns []ReportColumn
Views [][]int
DateFormat string
}
```

<a name="NewReport"></a>
### func [NewReport](<https://github.com/cinar/indicator/blob/master/helper/report.go#L60>)
### func [NewReport](<https://github.com/cinar/indicator/blob/master/helper/report.go#L59>)

```go
func NewReport(title string, date <-chan time.Time) *Report
Expand All @@ -1063,7 +1076,7 @@ func NewReport(title string, date <-chan time.Time) *Report
NewReport takes a channel of time as the time axis and returns a new instance of the Report struct. This instance can later be used to add data and annotations and subsequently generate a report.

<a name="Report.AddChart"></a>
### func \(\*Report\) [AddChart](<https://github.com/cinar/indicator/blob/master/helper/report.go#L76>)
### func \(\*Report\) [AddChart](<https://github.com/cinar/indicator/blob/master/helper/report.go#L74>)

```go
func (r *Report) AddChart() int
Expand All @@ -1072,7 +1085,7 @@ func (r *Report) AddChart() int
AddChart adds a new chart to the report and returns its unique identifier. This identifier can be used later to refer to the chart and add columns to it.

<a name="Report.AddColumn"></a>
### func \(\*Report\) [AddColumn](<https://github.com/cinar/indicator/blob/master/helper/report.go#L83>)
### func \(\*Report\) [AddColumn](<https://github.com/cinar/indicator/blob/master/helper/report.go#L81>)

```go
func (r *Report) AddColumn(column ReportColumn, charts ...int)
Expand All @@ -1081,7 +1094,7 @@ func (r *Report) AddColumn(column ReportColumn, charts ...int)
AddColumn adds a new data column to the specified charts. If no chart is specified, it will be added to the main chart.

<a name="Report.WriteToFile"></a>
### func \(\*Report\) [WriteToFile](<https://github.com/cinar/indicator/blob/master/helper/report.go#L111>)
### func \(\*Report\) [WriteToFile](<https://github.com/cinar/indicator/blob/master/helper/report.go#L109>)

```go
func (r *Report) WriteToFile(fileName string) error
Expand All @@ -1090,7 +1103,7 @@ func (r *Report) WriteToFile(fileName string) error
WriteToFile writes the generated report content to a file with the specified name. This allows users to conveniently save the report for later viewing or analysis.

<a name="Report.WriteToWriter"></a>
### func \(\*Report\) [WriteToWriter](<https://github.com/cinar/indicator/blob/master/helper/report.go#L99>)
### func \(\*Report\) [WriteToWriter](<https://github.com/cinar/indicator/blob/master/helper/report.go#L97>)

```go
func (r *Report) WriteToWriter(writer io.Writer) error
Expand All @@ -1099,7 +1112,7 @@ func (r *Report) WriteToWriter(writer io.Writer) error
WriteToWriter writes the report content to the provided io.Writer. This allows the report to be sent to various destinations, such as a file, a network socket, or even the standard output.

<a name="ReportColumn"></a>
## type [ReportColumn](<https://github.com/cinar/indicator/blob/master/helper/report.go#L23-L35>)
## type [ReportColumn](<https://github.com/cinar/indicator/blob/master/helper/report.go#L28-L40>)

ReportColumn defines the interface that all report data columns must implement. This interface ensures that different types of data columns can be used consistently within the report generation process.

Expand Down
7 changes: 1 addition & 6 deletions pre-commit.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ gosec ./...

revive -config=revive.toml ./...
staticcheck ./...

for package in "${PACKAGES[@]}";
do
echo Package "$package"
gomarkdoc --output "$package"/README.md ./"$package"
done
gomarkdoc ./...

markdownfmt -w README.md

9 changes: 6 additions & 3 deletions strategy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ func (a *AndStrategy) Report(c <-chan *asset.Snapshot) *helper.Report
Report processes the provided asset snapshots and generates a report annotated with the recommended actions.

<a name="Backtest"></a>
## type [Backtest](<https://github.com/cinar/indicator/blob/master/strategy/backtest.go#L44-L65>)
## type [Backtest](<https://github.com/cinar/indicator/blob/master/strategy/backtest.go#L44-L68>)

Backtest function rigorously evaluates the potential performance of the specified strategies applied to a defined set of assets. It generates comprehensive visual representations for each strategy\-asset pairing.

Expand All @@ -271,12 +271,15 @@ type Backtest struct {

// WriteStrategyReports indicates whether the individual strategy reports should be generated.
WriteStrategyReports bool

// DateFormat is the date format that is used in the reports.
DateFormat string
// contains filtered or unexported fields
}
```

<a name="NewBacktest"></a>
### func [NewBacktest](<https://github.com/cinar/indicator/blob/master/strategy/backtest.go#L89>)
### func [NewBacktest](<https://github.com/cinar/indicator/blob/master/strategy/backtest.go#L92>)

```go
func NewBacktest(repository asset.Repository, outputDir string) *Backtest
Expand All @@ -285,7 +288,7 @@ func NewBacktest(repository asset.Repository, outputDir string) *Backtest
NewBacktest function initializes a new backtest instance.

<a name="Backtest.Run"></a>
### func \(\*Backtest\) [Run](<https://github.com/cinar/indicator/blob/master/strategy/backtest.go#L105>)
### func \(\*Backtest\) [Run](<https://github.com/cinar/indicator/blob/master/strategy/backtest.go#L109>)

```go
func (b *Backtest) Run() error
Expand Down
12 changes: 6 additions & 6 deletions trend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ func (h *Hma[T]) String() string
String is the string representation of the HMA.

<a name="Kama"></a>
## type [Kama](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L39-L48>)
## type [Kama](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L38-L47>)

Kama represents the parameters for calculating the Kaufman's Adaptive Moving Average \(KAMA\). It is a type of moving average that adapts to market noise or volatility. It tracks prices closely during periods of small price swings and low noise.

Expand Down Expand Up @@ -715,7 +715,7 @@ type Kama[T helper.Number] struct {
```

<a name="NewKama"></a>
### func [NewKama](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L51>)
### func [NewKama](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L50>)

```go
func NewKama[T helper.Number]() *Kama[T]
Expand All @@ -724,7 +724,7 @@ func NewKama[T helper.Number]() *Kama[T]
NewKama function initializes a new KAMA instance with the default parameters.

<a name="NewKamaWith"></a>
### func [NewKamaWith](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L60>)
### func [NewKamaWith](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L59>)

```go
func NewKamaWith[T helper.Number](erPeriod, fastScPeriod, slowScPeriod int) *Kama[T]
Expand All @@ -733,7 +733,7 @@ func NewKamaWith[T helper.Number](erPeriod, fastScPeriod, slowScPeriod int) *Kam
NewKamaWith function initializes a new KAMA instance with the given parameters.

<a name="Kama[T].Compute"></a>
### func \(\*Kama\[T\]\) [Compute](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L69>)
### func \(\*Kama\[T\]\) [Compute](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L68>)

```go
func (k *Kama[T]) Compute(closings <-chan T) <-chan T
Expand All @@ -742,7 +742,7 @@ func (k *Kama[T]) Compute(closings <-chan T) <-chan T
Compute function takes a channel of numbers and computes the KAMA over the specified period.

<a name="Kama[T].IdlePeriod"></a>
### func \(\*Kama\[T\]\) [IdlePeriod](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L138>)
### func \(\*Kama\[T\]\) [IdlePeriod](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L134>)

```go
func (k *Kama[T]) IdlePeriod() int
Expand All @@ -751,7 +751,7 @@ func (k *Kama[T]) IdlePeriod() int
IdlePeriod is the initial period that KAMA yield any results.

<a name="Kama[T].String"></a>
### func \(\*Kama\[T\]\) [String](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L143>)
### func \(\*Kama\[T\]\) [String](<https://github.com/cinar/indicator/blob/master/trend/kama.go#L139>)

```go
func (k *Kama[T]) String() string
Expand Down
Loading