doctest

Documentation

Overview

Package doctest provides helper functions to test a documentation block of a function.

Index

• func RunTest(expectRequest bool, test func())
• type Doc
  • func ParseDoc(s string) (*Doc, error)

Functions

func RunTest

func RunTest(expectRequest bool, test func())

RunTest mocks an test http server.

Types

type Doc

type Doc struct {
	Description string
	Fields      map[string]string
}

Doc represents an documentation block.

func ParseDoc

func ParseDoc(s string) (*Doc, error)

ParseDoc parses an documentation block and returns an instance to Doc. It will parse Sections separated by a colon and populate them in the Doc.Fields field. Example: Take following input: Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Field1:

Hello World

Field2:

Good Bye World

Will return

Doc{
   Description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
   Fields: map[string]string{
       "Field1": "Hello World",
       "Field2": "Good Bye World",
   },
}.