sections

package

v0.0.0-...-1c4df2c Latest Latest Go to latest Published: Mar 1, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/calebamiles/keps

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Filename(name string) string
func IsAutogenerated(name string) bool
func Locations(entries []Entry) []string
func NameForFilename(filename string) string
func Persist(ss []Entry) error
type ByOrder
type Entry

Constants ¶

View Source

const (
	Summary            = rendering.SummaryName
	Motivation         = rendering.MotivationName
	DeveloperGuide     = rendering.DeveloperGuideName
	OperatorGuide      = rendering.OperatorGuideName
	TeacherGuide       = rendering.TeacherGuideName
	GraduationCriteria = rendering.GraduationCriteriaName
	Readme             = rendering.ReadmeName
)

Variables ¶

This section is empty.

Functions ¶

func Filename ¶

func Filename(name string) string

func IsAutogenerated ¶

func IsAutogenerated(name string) bool

func Locations ¶

func Locations(entries []Entry) []string

func NameForFilename ¶

func NameForFilename(filename string) string

func Persist ¶

func Persist(ss []Entry) error

Persist attempts persist all given sections; returning all errors

Types ¶

type ByOrder ¶

type ByOrder []string

func (ByOrder) Len ¶

func (entries ByOrder) Len() int

func (ByOrder) Less ¶

func (entries ByOrder) Less(i, j int) bool

func (ByOrder) Swap ¶

func (entries ByOrder) Swap(i, j int)

type Entry ¶

type Entry interface {
	Filename() string
	Name() string
	Content() []byte
	Persist() error
}

func AutoGeneratedFrom ¶

func AutoGeneratedFrom(info renderingInfoProvider) ([]Entry, error)

func Open ¶

func Open(prv sectionLocationsProvider) ([]Entry, error)

func Render ¶

func Render(info renderingInfoProvider, name string) (Entry, error)

func RenderMissingForDraftlState ¶

func RenderMissingForDraftlState(provider renderingInfoProvider) ([]Entry, error)

func RenderMissingForImplementableState ¶

func RenderMissingForImplementableState(provider renderingInfoProvider) ([]Entry, error)

func RenderMissingForProvisionalState ¶

func RenderMissingForProvisionalState(provider renderingInfoProvider) ([]Entry, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
rendering
unrendered
sectionsfakes Code generated by counterfeiter.	Code generated by counterfeiter.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL