docstring

Documentation

Index

• Constants
• func ParseAllDocStrings(iDoc *docspb.InternalPXLDocs) (*docspb.StructuredDocs, error)
• type FunctionDocstring

Constants

const CompileTimeFns = "compile_time_fn"

CompileTimeFns is the topic for functions that execute at compile time.

const DataFrameOps = "dataframe_ops"

DataFrameOps topic is for dataframe operations.

const OTelFunctions = "otel"

OTelFunctions is the topic for PxL OpenTelemetry exporter functions.

const PixieMutation = "pixie_state_management"

PixieMutation is the topic for any state changes.

const TracepointDecorator = "tracepoint_decorator"

TracepointDecorator is the topic for the tracepoint decorator.

const TracepointFields = "tracepoint_fields"

TracepointFields is the topic for the tracepoint fields.

Functions

func ParseAllDocStrings

func ParseAllDocStrings(iDoc *docspb.InternalPXLDocs) (*docspb.StructuredDocs, error)

ParseAllDocStrings takes the doc object and returns a new version where its docstring and children Docs are parsed.

Types

type FunctionDocstring

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

FunctionDocstring is the generic structure that contains documentation for functions.