Skip to content

Commit

Permalink
[README] Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
jylitalo committed Sep 19, 2023
1 parent d344cb3 commit 939c3a9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Main target audience is private golang projects or anyone, who wants to keep doc

`go build go2md.go` will produce you go2md binary.

Imports: 5
Imports: 8

## Index
- [Variables](variables)
Expand Down
8 changes: 4 additions & 4 deletions pkg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ var ErrNoPackageFound = errors.New("couldn't find package from ")

## Functions

### func [RunDirTree](./run.go#L131)
### func [RunDirTree](./run.go#L130)

<pre>
func RunDirTree(out <a href="#type-outputsettings">OutputSettings</a>, version string, includeMain bool) error
Expand All @@ -43,7 +43,7 @@ RunDirTree checks given directory and its subdirectories with RunDirectory().
Ignores all ErrNoPackageFound errors from RunDirectory.


### func [RunDirectory](./run.go#L121)
### func [RunDirectory](./run.go#L120)

<pre>
func RunDirectory(out <a href="#type-outputsettings">OutputSettings</a>, version string, includeMain bool) error
Expand All @@ -53,7 +53,7 @@ Returns ErrNoPackagesFound if includeMain=true and current directory has only ma


## Types
### type [OutputSettings](./run.go#L22)
### type [OutputSettings](./run.go#L21)

<pre>
type OutputSettings struct {
Expand All @@ -62,7 +62,7 @@ type OutputSettings struct {
Filename string
}
</pre>
### func (output *OutputSettings) [Writer](./run.go#L107)
### func (output *OutputSettings) [Writer](./run.go#L106)
<pre>
func (output *OutputSettings) Writer() (<a href="https://pkg.go.dev/io#WriteCloser">io.WriteCloser</a>, error)
</pre>
Expand Down

0 comments on commit 939c3a9

Please sign in to comment.