Skip to content

Commit

Permalink
#74 Update documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
docktermj committed Aug 20, 2024
1 parent 332bd6f commit a0bd2b8
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 50 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ $(PLATFORMS):
.PHONY: build
build: build-osarch-specific


# -----------------------------------------------------------------------------
# Run
# -----------------------------------------------------------------------------
Expand Down
3 changes: 3 additions & 0 deletions cmdhelper/doc.go
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
/*
Package cmdhelper has functions used with cobra.Command.
*/
package cmdhelper
3 changes: 3 additions & 0 deletions constant/doc.go
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
/*
Package constant has constants used with cobra.Command.
*/
package constant
50 changes: 1 addition & 49 deletions doc.go
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
4 changes: 4 additions & 0 deletions option/doc.go
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
4 changes: 4 additions & 0 deletions option/optiontype/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Package optiontype has the types of context variables.
*/
package optiontype
3 changes: 3 additions & 0 deletions settings/doc.go
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

0 comments on commit a0bd2b8

Please sign in to comment.