helpinfo

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 3, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CustomRenderSignatures

func CustomRenderSignatures(signatures []*lsp.SignatureInformation) string

CustomRenderSignatures renders a list of signatures as a markdown string.

func RenderBasicDataSourceInfo

func RenderBasicDataSourceInfo(
	dataSourceName string,
	dataSource *schema.DataSource,
) string

RenderBasicDataSourceInfo renders basic data source information for use in help info.

func RenderBasicResourceInfo

func RenderBasicResourceInfo(resourceName string, resource *schema.Resource) string

RenderBasicResourceInfo renders basic resource information for use in help info.

func RenderChildInfo

func RenderChildInfo(childName string, child *schema.Include) string

RenderChildInfo renders child blueprint information for use in help info.

func RenderDataSourceFieldInfo

func RenderDataSourceFieldInfo(
	dataSourceName string,
	dataSource *schema.DataSource,
	dataSourceRef *substitutions.SubstitutionDataSourceProperty,
	dataSourceField *schema.DataSourceFieldExport,
) string

RenderDataSourceFieldInfo renders data source field information for use in help info.

func RenderElemIndexRefInfo

func RenderElemIndexRefInfo(
	resourceName string,
	resource *schema.Resource,
) string

RenderElemIndexRefInfo renders element index reference information for use in help info.

func RenderElemRefInfo

func RenderElemRefInfo(
	resourceName string,
	resource *schema.Resource,
	elemRef *substitutions.SubstitutionElemReference,
) string

RenderElemRefInfo renders element reference information for use in help info.

func RenderResourceDefinitionFieldInfo

func RenderResourceDefinitionFieldInfo(
	resourceName string,
	resource *schema.Resource,
	resRef *substitutions.SubstitutionResourceProperty,
	specFieldSchema *provider.ResourceDefinitionsSchema,
) string

RenderResourceDefinitionFieldInfo renders resource definition field information for use in help info.

func RenderValueInfo

func RenderValueInfo(valueName string, value *schema.Value) string

RenderValueInfo renders value information for use in help info.

func RenderVariableInfo

func RenderVariableInfo(varName string, variable *schema.Variable) string

RenderVariableInfo renders variable information for use in help info.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL