docs

Documentation

Index

• func FormatAPIClass(api *APIClass) string
• func FormatOperator(key string, op *Operator) string
• func ListAPIClasses() []string
• func ListCategories() map[string]int
• type APIClass
  • func LookupAPI(query string) (string, *APIClass)
• type Member
• type Method
• type Operator
  • func LookupOperator(query string) (string, *Operator)
• type Param
• type SearchResult
  • func SearchOperators(query string, category string, limit int) []SearchResult

Functions

func FormatAPIClass

func FormatAPIClass(api *APIClass) string

FormatAPIClass returns a human-readable string for a Python API class.

func FormatOperator

func FormatOperator(key string, op *Operator) string

FormatOperator returns a human-readable string for an operator.

func ListAPIClasses

func ListAPIClasses() []string

ListAPIClasses returns all Python API class names.

func ListCategories

func ListCategories() map[string]int

ListCategories returns operator counts by category.

Types

type APIClass

type APIClass struct {
	Name    string   `json:"name"`
	Desc    string   `json:"desc"`
	Members []Member `json:"mem"`
	Methods []Method `json:"met"`
}

func LookupAPI

func LookupAPI(query string) (string, *APIClass)

LookupAPI finds a Python API class by name.

type Member

type Member struct {
	Name string `json:"n"`
	Type string `json:"t"`
	RO   bool   `json:"ro"`
}

type Method

type Method struct {
	Name string `json:"n"`
	Sig  string `json:"s"`
	Ret  string `json:"r"`
}

type Operator

type Operator struct {
	Name     string   `json:"name"`
	Category string   `json:"cat"`
	Summary  string   `json:"sum"`
	Params   []Param  `json:"pars"`
	Tips     []string `json:"tips"`
	Examples []string `json:"ex"`
}

func LookupOperator

func LookupOperator(query string) (string, *Operator)

LookupOperator finds an operator by name (case-insensitive, partial match).

type Param

type Param struct {
	Name    string      `json:"n"`
	Label   string      `json:"l"`
	Group   string      `json:"g"`
	Default interface{} `json:"d"`
}

type SearchResult

type SearchResult struct {
	Key      string
	Name     string
	Category string
	Summary  string
	Score    int
}

func SearchOperators

func SearchOperators(query string, category string, limit int) []SearchResult

SearchOperators searches operators by keyword.