vocabularycheck

Documentation

Overview

Package vocabularycheck owns glossary and pitfall-tag vocabulary policy.

Index

• Constants
• type Input
• type Results
  • func Evaluate(input Input) (Results, error)

Constants

const (
	// PropertyCorrectness is the protected property for vocabulary validity.
	PropertyCorrectness checkresult.Property = "correctness"
	// PropertyHeuristic is the protected property for vocabulary warnings.
	PropertyHeuristic checkresult.Property = "heuristic-quality"
)

Types

type Input

type Input struct {
	GlossaryEnabled  bool
	Authored, Merged []glossary.Record
	Domains          []string
	Tags             map[string]string
	Pitfalls         pitfall.Corpus
}

Input is a defensive prepared semantic projection.

type Results

type Results struct {
	Glossary checkresult.Result
	Tags     checkresult.Result
}

Results keeps glossary and tag results distinct so aggregation can preserve their established error and advisory placements without inspecting kinds.

func Evaluate

func Evaluate(input Input) (Results, error)

Evaluate evaluates each vocabulary concern once over prepared values.