Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

fix NewSafeWriter godoc formatting #708

Merged
merged 1 commit into from
Jun 2, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions txn_writer.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,16 @@ type SafeWriter struct {
// NewSafeWriter sets up a SafeWriter to write a set of config yaml, lock and vendor tree.
//
// - If manifest is provided, it will be written to the standard manifest file
// name beneath root.
// name beneath root.
//
// - If newLock is provided, it will be written to the standard lock file
// name beneath root.
// name beneath root.
//
// - If vendor is VendorAlways, or is VendorOnChanged and the locks are different,
// the vendor directory will be written beneath root based on newLock.
// the vendor directory will be written beneath root based on newLock.
//
// - If oldLock is provided without newLock, error.
//
// - If vendor is VendorAlways without a newLock, error.
func NewSafeWriter(manifest *Manifest, oldLock, newLock *Lock, vendor VendorBehavior) (*SafeWriter, error) {
sw := &SafeWriter{
Expand Down