synonyms

Documentation

Overview

Package synonyms provides a builder for filtering and replacing synonyms in a token stream

Index

• func NewFilter(mappings map[string]string, ignoreCase bool, ignoreRunes []rune) jargon.Filter
• type Filter
  • func (f *Filter) Decl() string
  • func (f *Filter) Filter(incoming *jargon.TokenStream) *jargon.TokenStream
  • func (f *Filter) String() string

Functions

func NewFilter

func NewFilter(mappings map[string]string, ignoreCase bool, ignoreRunes []rune) jargon.Filter

NewFilter creates a new synonyms Filter

Types

type Filter

type Filter struct {
	// contains filtered or unexported fields
}

Filter is the data structure of a synonyms filter. Use NewFilter to create.

func (*Filter) Decl

func (f *Filter) Decl() string

Decl returns a Go source declaration of the Filter

func (*Filter) Filter

func (f *Filter) Filter(incoming *jargon.TokenStream) *jargon.TokenStream

Filter replaces tokens with their canonical terms, based on Stack Overflow tags & synonyms

func (*Filter) String

func (f *Filter) String() string

String returns a Go source declaration of the Filter