Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderRelevantPackages ¶
func RenderRelevantPackages(pkgs []PackageExplanation) string
Types ¶
type Explanation ¶
type Explanation struct {
Target string `json:"target"`
Kind string `json:"kind"`
Description string `json:"description,omitempty"`
Task *TaskExplanation `json:"task,omitempty"`
Package *PackageExplanation `json:"package,omitempty"`
Glossary *GlossaryExplanation `json:"glossary,omitempty"`
Markdown string `json:"markdown"`
}
type GlossaryExplanation ¶
type PackageExplanation ¶
type PackageExplanation struct {
Name string `json:"name"`
Description string `json:"description"`
KeyTypes []string `json:"key_types,omitempty"`
EntryPoints []string `json:"entry_points,omitempty"`
Conventions []string `json:"conventions,omitempty"`
DependsOn []string `json:"depends_on,omitempty"`
}
func RelevantPackages ¶
func RelevantPackages(cfg *config.Config, scopePaths []string) []PackageExplanation
type TaskExplanation ¶
type TaskExplanation struct {
Name string `json:"name"`
Description string `json:"description"`
Type string `json:"type"`
Scope string `json:"scope,omitempty"`
ScopePaths []string `json:"scope_paths,omitempty"`
Needs []string `json:"needs,omitempty"`
Steps []string `json:"steps,omitempty"`
Command string `json:"command,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.