dcrd/sampleconfig/doc.go
Dave Collins be936bb622
sampleconfig: Make constant a function instead.
This modifies the sampleconfig package to contain a single function
named FileContents instead of a constant.

This is being done because changing a constant is technically a major
semver breaking change while changing the contents returned by a
function is not and the goal is to ultimately make the root module
semver compliant.
2020-09-02 13:21:37 -05:00

13 lines
528 B
Go

// Copyright (c) 2017-2020 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 function that returns 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