specdoc

package
v0.23.0 Latest Latest
Warning

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

Go to latest
Published: Oct 24, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package specdoc reads the tables of the north-star docs, so that tests can check that the code and the spec agree.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Backticked

func Backticked(cell string) []string

Backticked returns the code spans of a cell, such as -h and --help in "`-h`, `--help`".

func Block

func Block(path, heading string) ([]string, error)

Block returns the lines of the first fenced code block in the section whose title starts with heading.

func Tables

func Tables(path, heading string) ([][][]string, error)

Tables returns the body rows of every table in the section whose title starts with heading. Cells lose their surrounding spaces.

Types

This section is empty.

Jump to

Keyboard shortcuts

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