Function TestFunctionDocumentation

common/decls/decls_test.go:271–387

(t *testing.T)

}

func TestFunctionDocumentation(t *testing.T) {
	tests := []struct {
		name       string
		fn         *FunctionDecl
		signatures []string
		examples   []string
	}{
		{
			name: "function",
			fn: testFunction(t, "size",
				FunctionDocs(`compute the number of entries in a list or map`),
				MemberOverload("list_size",
					[]*types.Type{types.NewListType(types.NewTypeParamType("T"))}, types.IntType,
					OverloadExamples(`[].size() // 0`, `[1, 2, 3].size() // 3`)),
				Overload("size_list",
					[]*types.Type{types.NewListType(types.NewTypeParamType("T"))}, types.IntType,
					OverloadExamples(`size([]) // 0`, `size([1, 2, 3]) // 3`))),
			signatures: []string{
				"list(<T>).size() -> int",
				"size(list(<T>)) -> int",
			},
			examples: []string{
				`[].size() // 0`,
				`[1, 2, 3].size() // 3`,
				`size([]) // 0`,
				`size([1, 2, 3]) // 3`,
			},
		},
		{
			name: "type",
			fn: testFunction(t, overloads.TypeConvertType,
				Overload(overloads.TypeConvertType,
					[]*types.Type{types.NewTypeTypeWithParam(types.NewTypeParamType("T"))},
					types.TypeType,
					OverloadExamples(`type(int) // type`))),
			signatures: []string{"type(type) -> type"},
			examples:   []string{`type(int) // type`},
		},
		{
			name: "unary operator",
			fn: testFunction(t, operators.Negate,
				FunctionDocs(`negate a numeric value`),
				Overload(overloads.NegateInt64, []*types.Type{types.IntType}, types.IntType,
					OverloadExamples(`-(1) // -1`))),
			signatures: []string{"-int -> int"},
			examples:   []string{`-(1) // -1`},
		},
		{
			name: "binary operator",
			fn: testFunction(t, operators.Add,
				FunctionDocs(`add two numeric values`),
				Overload(overloads.AddInt64, []*types.Type{types.IntType, types.IntType}, types.IntType,
					OverloadExamples(`1 + 2 // 3`))),
			signatures: []string{"int + int -> int"},
			examples:   []string{`1 + 2 // 3`},
		},
		{
			name: "index operator",