Method description

commandline/parameter_formatter.go:23–56

(parameter parser.Parameter)

}

func (f parameterFormatter) description(parameter parser.Parameter) string {
	builder := strings.Builder{}

	builder.WriteString(f.humanReadableType(parameter.Type))

	fields := f.descriptionFields(parameter)
	if len(fields) > 0 {
		builder.WriteString(" (")
		builder.WriteString(f.commaSeparatedValues(fields))
		builder.WriteString(")")
	}

	if parameter.Description != "" {
		builder.WriteString("\n")
		builder.WriteString(parameter.Description)
	}

	if len(parameter.AllowedValues) > 0 {
		f.writeSeparator(&builder, "\n\n")
		builder.WriteString("Allowed values:")
		for _, value := range parameter.AllowedValues {
			builder.WriteString(fmt.Sprintf("\n- %v", value))
		}
	}

	example := f.usageExample(parameter)
	if example != "" {
		f.writeSeparator(&builder, "\n\n")
		builder.WriteString("Example:\n")
		builder.WriteString("   " + example)
	}

	return builder.String()
}

func (f parameterFormatter) descriptionFields(parameter parser.Parameter) []interface{} {
	fields := []interface{}{}