Method FunctionDoc

cmd/dagger/shell_help.go:384–426

(md *moduleDef, fn *modFunction)

}

func (h *shellCallHandler) FunctionDoc(md *moduleDef, fn *modFunction) string {
	var doc ShellDoc

	if fn.Description != "" {
		doc.Add("", fn.Description)
	}

	usage := h.FunctionUseLine(md, fn)
	if usage != "" {
		doc.Add("Usage", usage)
	}

	if args := fn.RequiredArgs(); len(args) > 0 {
		doc.Add(
			"Required Arguments",
			nameShortWrapped(args, func(a *modFunctionArg) (string, string) {
				return strings.TrimPrefix(a.Usage(), "--"), a.Long()
			}),
		)
	}

	if args := fn.OptionalArgs(); len(args) > 0 {
		doc.Add(
			"Optional Arguments",
			nameShortWrapped(args, func(a *modFunctionArg) (string, string) {
				return a.Usage(), a.Long()
			}),
		)
	}

	usage = strings.TrimSuffix(usage, " [options]")

	doc.Add(
		"Returns",
		fmt.Sprintf(`%s

Use "%s | .help" for more details.`,
			fn.ReturnType.Short(),
			strings.TrimSuffix(usage, " [options]"),
		))

	return doc.String()
}

func shellTypeDoc(t *modTypeDef) string {
	var doc ShellDoc