commit b6986e8e8f3ca2b9529e35cafe2340a4391376e8
from: Oliver Lowe <o@olowe.co>
date: Tue Mar 12 09:35:13 2024 UTC

apub: document our convenience Finger function

commit - 8aa989385f35e0296e6bd1fc0d575c1aa20a0b50
commit + b6986e8e8f3ca2b9529e35cafe2340a4391376e8
blob - d51eb9237bb67808d536aa8b3ed3dff989ec208e
blob + d52ec478bf7c67e3600af7ad3fec03dd03c53cff
--- webfinger.go
+++ webfinger.go
@@ -11,6 +11,9 @@ import (
 	"webfinger.net/go/webfinger"
 )
 
+// Finger is convenience function returning the corresponding Actor,
+// if any, of an address resolvable by WebFinger.
+// It is equivalent to doing webfinger.Lookup then LookupActor.
 func Finger(address string) (*Actor, error) {
 	jrd, err := webfinger.Lookup(address, nil)
 	if err != nil {