From d88661935fa2b6e2c0fe93345800113e1a71b451 Mon Sep 17 00:00:00 2001 From: ewy Date: Wed, 22 Apr 2026 21:51:29 +0200 Subject: docs --- describe/describe.go | 3 +++ 1 file changed, 3 insertions(+) (limited to 'describe/describe.go') diff --git a/describe/describe.go b/describe/describe.go index 0863b6d..a7070a1 100644 --- a/describe/describe.go +++ b/describe/describe.go @@ -15,6 +15,7 @@ var DescriptionPrefixes = []string{ var descriptions = make(map[model.Target]*string) +// Describe attempts to read a description from a file and stores it in the cache func Describe(key model.Target, file string) (string, error) { if d := descriptions[key]; d != nil { return *d, nil @@ -35,6 +36,8 @@ func Describe(key model.Target, file string) (string, error) { return text, err } +// FromReader reads a description from an io.Reader and returns it. +// this is not stored in the cache. func FromReader(reader io.Reader) (string, error) { scanner := bufio.NewScanner(reader) scanner.Split(bufio.ScanLines) -- cgit v1.3.1