linewrap

README

Package cloudeng.io/text/linewrap

import cloudeng.io/text/linewrap

Package linewrap provides basic support for wrapping text to a given width.

Functions

Func Block

func Block(indent, width int, text string) string

Block wraps the supplied text to width indented by indent spaces.

Func Comment

func Comment(indent, width int, comment, text string) string

Comment wraps the supplied text to width indented by indent spaces with each line starting with the supplied comment string. It is intended for formatting source code comments.

Func Paragraph

func Paragraph(initial, indent, width int, text string) string

Paragraph wraps the supplied text as a 'paragraph' with separate indentation for the initial and subsequent lines to the specified width.

Documentation

Overview

Package linewrap provides basic support for wrapping text to a given width.

Index

• func Block(indent, width int, text string) string
• func Comment(indent, width int, comment, text string) string
• func Paragraph(initial, indent, width int, text string) string

Functions

func Block

func Block(indent, width int, text string) string

Block wraps the supplied text to width indented by indent spaces.

func Comment

func Comment(indent, width int, comment, text string) string

Comment wraps the supplied text to width indented by indent spaces with each line starting with the supplied comment string. It is intended for formatting source code comments.

func Paragraph

func Paragraph(initial, indent, width int, text string) string

Paragraph wraps the supplied text as a 'paragraph' with separate indentation for the initial and subsequent lines to the specified width.