flowdoc

package
v1.166.0 Latest Latest
Warning

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

Go to latest
Published: Nov 19, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package flowdoc reads what a script's author wrote about a function: the first sentence of the comment above it, at the top of its body, or of its docstring, which a flow diagram's boxes are captioned with.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Caption

func Caption(d *syntax.DefStmt, maxRunes int) string

Caption is the first sentence of the comment the author wrote above a def, or at the top of its body, or else of its docstring. A script created since #1938 documents every function, so its every box carries a sentence a reader who does not read code can follow.

func DocSentence

func DocSentence(s syntax.Stmt, maxRunes int) string

DocSentence is the first sentence of a docstring statement, or "" when the statement is not one.

Types

This section is empty.

Jump to

Keyboard shortcuts

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