mirror of
https://github.com/opentofu/opentofu.git
synced 2025-02-25 18:45:20 -06:00
783a07d9e8
Go 1.19's "fmt" has some awareness of the new doc comment formatting conventions and adjusts the presentation of the source comments to make it clearer how godoc would interpret them. Therefore this commit includes various updates made by "go fmt" to acheve that. In line with our usual convention that we make stylistic/grammar/spelling tweaks typically only when we're "in the area" changing something else anyway, I also took this opportunity to review most of the comments that this updated to see if there were any other opportunities to improve them.
27 lines
871 B
Go
27 lines
871 B
Go
package statemgr
|
|
|
|
// Storage is the union of Transient and Persistent, for state managers that
|
|
// have both transient and persistent storage.
|
|
//
|
|
// Types implementing this interface coordinate between their Transient
|
|
// and Persistent implementations so that the persistent operations read
|
|
// or write the transient store.
|
|
type Storage interface {
|
|
Transient
|
|
Persistent
|
|
}
|
|
|
|
// Full is the union of all of the more-specific state interfaces.
|
|
//
|
|
// This interface may grow over time, so state implementations aiming to
|
|
// implement it may need to be modified for future changes. To ensure that
|
|
// this need can be detected, always include a statement nearby the declaration
|
|
// of the implementing type that will fail at compile time if the interface
|
|
// isn't satisfied, such as:
|
|
//
|
|
// var _ statemgr.Full = (*ImplementingType)(nil)
|
|
type Full interface {
|
|
Storage
|
|
Locker
|
|
}
|