-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
52 lines (37 loc) · 1.36 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*
One or two sentence synopsys of the module. The Senzing XXXX module is...
# Overview
One or two paragraph overview of this module...
(This page describes the nature of the entire Go module or the top-level command, not an individual package.)
More information at https://github.com/senzing/go-cmdhelping
# Example Package
The example package gives an example layout for a package. This includes how
documentation, tests, and examples should be done. This paragraph (or two)
should provide a brief overview while linking the reader to the documentation
included in the package itself.
More information can be found in the [pkg/github.com/senzing/go-cmdhelping/examplepackage] documentation.
# Another Header: Package or other module features...
More details about the module...
Lorem ipsum dolor sit amet, consectetur adipiscing elit...
# Examples
The examples given here should show a holistic view of the module, if appropriate.
Examples of use can be seen in the main_test.go files.
package main
import (
fmt
"github.com/senzing/go-cmdhelping/examplepackage"
"github.com/senzing/go-cmdhelping/anotherpackage"
)
func main() {
ctx := context.TODO()
testObject := &ExamplePackageImpl{
Something: "I'm here",
}
err := testObject.SaySomething(ctx)
if err != nil {
fmt.Println("whoops")
}
anotherpackage.DoSomething(ctx)...
}
*/
package main