docstring

Documentation

Index

• Constants
• func Get(n string) (string, error)
• func MustGet(n string) string
• func Names() []string

Constants

const ErrSymbolNotDocumented = "symbol not documented: %s"

ErrSymbolNotDocumented is raised when a call to doc can't resolve a name

Functions

func Get

func Get(n string) (string, error)

Get resolves a registered docstring entry by name

func MustGet

func MustGet(n string) string

MustGet resolves a registered docstring entry by name or explodes

func Names

func Names() []string

Names returns the registered names of available docstring entries