-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
18 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,4 @@ | ||
/* | ||
Package cmdhelper has functions used with cobra.Command. | ||
*/ | ||
package cmdhelper |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,4 @@ | ||
/* | ||
Package constant has constants used with cobra.Command. | ||
*/ | ||
package constant |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,4 @@ | ||
/* | ||
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-garage/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-garage/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-garage/go-cmdhelping/examplepackage" | ||
"github.com/senzing-garage/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)... | ||
} | ||
The go-cmdhelping packages are used in writing command-line interfaces. | ||
*/ | ||
package main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/* | ||
Package option has definitions for context variables and command line parameters. | ||
*/ | ||
package option |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/* | ||
Package optiontype has the types of context variables. | ||
*/ | ||
package optiontype |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,4 @@ | ||
/* | ||
Package settings has functions to build the settings JSON passed into Senzing init() methods. | ||
*/ | ||
package settings |