docstring

package
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Sep 9, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package docstring provides documentation access for core library functions

Index

Constants

This section is empty.

Variables

View Source 
var ErrSymbolNotDocumented = errors.New("symbol not documented")

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

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.