Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderModuleReadme ¶
func RenderModuleReadme(summary ModuleReadmeSummary) string
func RenderWalkthrough ¶
func RenderWalkthrough(w Walkthrough, report string) (string, error)
Types ¶
type ModuleReadmeSummary ¶
type ModuleReadmeSummary struct {
Module string
DependsOn []string
DependedOnBy []string
PublicAPI []PublicAPISymbol
Tests []TestFileSummary
}
func BuildModuleReadmeSummary ¶
func BuildModuleReadmeSummary(root, modulePath string) (ModuleReadmeSummary, error)
type TestFileSummary ¶
type Walkthrough ¶
type Walkthrough struct {
Seed WalkthroughSeed `json:"seed"`
Files []WalkthroughFile `json:"files"`
}
func BuildWalkthrough ¶
func BuildWalkthrough(root string, limit int) (Walkthrough, error)
type WalkthroughFile ¶
Click to show internal directories.
Click to hide internal directories.