Skip to content

Commit

Permalink
docs(readme): fix option for template overriding in example (#92)
Browse files Browse the repository at this point in the history
Co-authored-by: Jeff Principe <[email protected]>
  • Loading branch information
ccamel and princjef authored Jun 11, 2023
1 parent cac02fa commit 88639c6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,10 @@ The documentation information that is output is formatted using a series of text

- import: generates the import code used to pull in a package.

Overriding with the \-t option uses a key\-vaule pair mapping a template name to the file containing the contents of the override template to use. Specified template files must exist:
Overriding with the \-\-template\-file option uses a key\-value pair mapping a template name to the file containing the contents of the override template to use. Specified template files must exist:

```
gomarkdoc -t package=custom-package.gotxt -t doc=custom-doc.gotxt .
gomarkdoc --template-file package=custom-package.gotxt --template-file doc=custom-doc.gotxt .
```

### Additional Options
Expand Down
8 changes: 4 additions & 4 deletions doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@
//
// - import: generates the import code used to pull in a package.
//
// Overriding with the -t option uses a key-vaule pair mapping a template name
// to the file containing the contents of the override template to use.
// Specified template files must exist:
// Overriding with the --template-file option uses a key-value pair mapping a
// template name to the file containing the contents of the override template to
// use. Specified template files must exist:
//
// gomarkdoc -t package=custom-package.gotxt -t doc=custom-doc.gotxt .
// gomarkdoc --template-file package=custom-package.gotxt --template-file doc=custom-doc.gotxt .
//
// # Additional Options
//
Expand Down

0 comments on commit 88639c6

Please sign in to comment.