octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-11-18 11:05:18 +00:00
Code Issues Releases Wiki Activity
92421ec47f
restic/vendor/cloud.google.com/go/internal/snipdoc
History
Alexander Neumann 2b39f9f4b2 Update dependencies 
Among others, this updates minio-go, so that the new "eu-west-3" zone
for AWS is supported.
2018-01-23 19:40:42 +01:00
..
README.md Update dependencies 2018-01-23 19:40:42 +01:00
sample-makefile Update dependencies 2018-01-23 19:40:42 +01:00
snipdoc.awk Update dependencies 2018-01-23 19:40:42 +01:00

README.md

Snipdoc

Snipdoc is a simple tool for maintaining package documentation that contains code samples.

  1. Create a subdirectory of your package to hold the following files. "internal" is a good name.

  2. Write a template file (for example, "doc.template") with the text of your package documentation. The file should look exactly like you want your doc.go file to look, except for code snippets. Instead of embedding a code snippet, write a line consisting solely of

[NAME]

for your choice of NAME.

  1. Write a snippets file (for example, "doc-snippets.go") as a valid Go source file. Begin each snippet you'd like to appear in your package docs with //[ NAME and end it with //].

  2. Construct your doc.go file with the command

    awk -f snipdoc.awk doc-snippets.go doc.template

    The file "sample-makefile" in this directory verifies that the snippets file compiles and safely constructs a doc.go file.