english

Documentation

Overview

Package english contains minor utilities for generating English-language text.

Index

• func Conjoin(ss []string, conj string) string
• type Wrapper
  • func NewWrapper(w io.Writer) *Wrapper
  • func (ww *Wrapper) Close() (err error)
  • func (ww *Wrapper) Write(b []byte) (n int, err error)
  • func (ww *Wrapper) WriteString(s string) (int, error)

Functions

func Conjoin

func Conjoin(ss []string, conj string) string

Conjoin returns a set of strings joined together with the specified conjunction and (of course) the Oxford comma.

Types

type Wrapper

type Wrapper struct {
	// contains filtered or unexported fields
}

Wrapper is a rudimentary word-wrapper. Text written to it is word-wrapped at 78 columns. Lines starting with space characters are left untouched.

func NewWrapper

func NewWrapper(w io.Writer) *Wrapper

NewWrapper creates a new Wrapper, writing to the provided writer. The Wrapper must be closed to flush the last line of output.

func (*Wrapper) Close

func (ww *Wrapper) Close() (err error)

Close flushes the Wrapper output and closes it.

func (*Wrapper) Write

func (ww *Wrapper) Write(b []byte) (n int, err error)

func (*Wrapper) WriteString

func (ww *Wrapper) WriteString(s string) (int, error)

WriteString writes a string to the Wrapper.