From dc0617cac36852df32193f2913bb36ee2bfc10e9 Mon Sep 17 00:00:00 2001
From: Jono Wenger <jono@elixxir.io>
Date: Wed, 10 Aug 2022 11:21:44 -0700
Subject: [PATCH] Make all fact.Fact and fact.FactList in bindings comments
links
---
bindings/e2eAuth.go | 2 +-
bindings/identity.go | 4 ++--
bindings/ud.go | 12 ++++++------
3 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/bindings/e2eAuth.go b/bindings/e2eAuth.go
index 12a031cf9..801a2829e 100644
--- a/bindings/e2eAuth.go
+++ b/bindings/e2eAuth.go
@@ -35,7 +35,7 @@ import (
//
// Parameters:
// - partnerContact - the marshalled bytes of the contact.Contact object.
-// - factsListJson - the JSON marshalled bytes of fact.FactList.
+// - factsListJson - the JSON marshalled bytes of [fact.FactList].
//
// Returns:
// - int64 - ID of the round (convert to uint64)
diff --git a/bindings/identity.go b/bindings/identity.go
index 23225baf0..d99f5a6ca 100644
--- a/bindings/identity.go
+++ b/bindings/identity.go
@@ -128,7 +128,7 @@ func GetPubkeyFromContact(marshaled []byte) ([]byte, error) {
//
// Parameters:
// - marshaled - the JSON marshalled by of contact.Contact object.
-// - factListJSON - the JSON marshalled bytes of fact.FactList.
+// - factListJSON - the JSON marshalled bytes of [fact.FactList].
func SetFactsOnContact(marshaled []byte, factListJSON []byte) ([]byte, error) {
cnt, err := contact.Unmarshal(marshaled)
if err != nil {
@@ -152,7 +152,7 @@ func SetFactsOnContact(marshaled []byte, factListJSON []byte) ([]byte, error) {
// - marshaled - the JSON marshalled by of contact.Contact object.
//
// Returns:
-// - []byte - the JSON marshalled bytes of fact.FactList.
+// - []byte - the JSON marshalled bytes of [fact.FactList].
func GetFactsFromContact(marshaled []byte) ([]byte, error) {
cnt, err := contact.Unmarshal(marshaled)
if err != nil {
diff --git a/bindings/ud.go b/bindings/ud.go
index 4272fbdb1..8a19f4821 100644
--- a/bindings/ud.go
+++ b/bindings/ud.go
@@ -165,8 +165,8 @@ func NewOrLoadUd(e2eID int, follower UdNetworkStatus,
// Parameters:
// - e2eID - e2e object ID in the tracker
// - follower - network follower func wrapped in UdNetworkStatus
-// - emailFactJson - nullable JSON marshalled email fact.Fact
-// - phoneFactJson - nullable JSON marshalled phone fact.Fact
+// - emailFactJson - nullable JSON marshalled email [fact.Fact]
+// - phoneFactJson - nullable JSON marshalled phone [fact.Fact]
// - cert is the TLS certificate for the UD server this call will connect with.
// You may use the UD server run by the xx network team by using E2e.GetUdCertFromNdf.
// - contactFile is the data within a marshalled contact.Contact. This represents the
@@ -213,7 +213,7 @@ func NewUdManagerFromBackup(e2eID int, follower UdNetworkStatus, emailFactJson,
return udTrackerSingleton.make(u), nil
}
-// GetFacts returns a JSON marshalled list of fact.Fact objects that exist
+// GetFacts returns a JSON marshalled list of [fact.Fact] objects that exist
// within the Store's registeredFacts map.
func (ud *UserDiscovery) GetFacts() []byte {
jsonData, err := json.Marshal(ud.api.GetFacts())
@@ -246,7 +246,7 @@ func (ud *UserDiscovery) ConfirmFact(confirmationID, code string) error {
// along with the code to finalize the fact.
//
// Parameters:
-// - factJson - a JSON marshalled fact.Fact
+// - factJson - a JSON marshalled [fact.Fact]
func (ud *UserDiscovery) SendRegisterFact(factJson []byte) (string, error) {
var f fact.Fact
err := json.Unmarshal(factJson, &f)
@@ -262,7 +262,7 @@ func (ud *UserDiscovery) SendRegisterFact(factJson []byte) (string, error) {
// be associated with this user.
//
// Parameters:
-// - factJson - a JSON marshalled fact.Fact
+// - factJson - a JSON marshalled [fact.Fact]
func (ud *UserDiscovery) PermanentDeleteAccount(factJson []byte) error {
var f fact.Fact
err := json.Unmarshal(factJson, &f)
@@ -385,7 +385,7 @@ type UdSearchCallback interface {
// - e2eID - e2e object ID in the tracker
// - udContact - the marshalled bytes of the contact.Contact for the user
// discovery server
-// - factListJSON - the JSON marshalled bytes of fact.FactList
+// - factListJSON - the JSON marshalled bytes of [fact.FactList]
// - singleRequestParams - the JSON marshalled bytes of single.RequestParams
//
// Returns:
--
GitLab