dcrd/sampleconfig/doc.go
Dave Collins f0a01ced0a
sampleconfig: Add package README and doc.go.
This adds a readme and doc.go for the sampleconfig package so it is
consistent with all of the other packages.

While here, it also changes the exported value to a constant and removes
the unused sampleConfigFilename constant.
2017-08-25 12:35:11 -05:00

13 lines
524 B
Go

// Copyright (c) 2017 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.
/*
Package sampleconfig provides a single constant that contains the contents of
the sample configuration file for dcrd. This is provided for tools that perform
automatic configuration and would like to ensure the generated configuration
file not only includes the specifically configured values, but also provides
samples of other configuration options.
*/
package sampleconfig