Improve NewVCardWithOptions() documentation

openrdap · Feb 19, 2024 · b416f22 · b416f22
1 parent 79e3d52
commit b416f22
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/vcard.go b/vcard.go
@@ -150,7 +150,12 @@ func NewVCard(jsonBlob []byte) (*VCard, error) {
 	return vcard, err
 }
 
-// NewVCardWithOptions creates a VCard from jsonBlob.
+// NewVCardWithOptions creates a VCard from jsonBlob. options specifies options for
+// the VCard decoder.
+//
+// Example usage:
+//
+//	vcard, err := NewVCardWithOptions(jsonBlob, VCardOptions{IgnoreInvalidProperties: true})
 func NewVCardWithOptions(jsonBlob []byte, options VCardOptions) (*VCard, error) {
 	var top []interface{}
 	err := json.Unmarshal(jsonBlob, &top)