From 70c6a360f4a40b42885cef226af451134eff5c77 Mon Sep 17 00:00:00 2001
From: Jono Wenger <jono@elixxir.io>
Date: Tue, 20 Sep 2022 09:53:56 -0700
Subject: [PATCH] Fix bindings comments
---
bindings/channels.go | 18 +++++++++---------
bindings/delivery.go | 8 ++++----
bindings/follow.go | 4 ++--
bindings/group.go | 2 +-
4 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/bindings/channels.go b/bindings/channels.go
index e3e8b3a1d..bbd5fba3a 100644
--- a/bindings/channels.go
+++ b/bindings/channels.go
@@ -322,7 +322,7 @@ func (cm *ChannelsManager) JoinChannel(channelPretty string) ([]byte, error) {
//
// JSON Example:
// {
-// U4x/lrFkvxuXu59LtHLon1sUhPJSCcnZND6SugndnVID",
+// "U4x/lrFkvxuXu59LtHLon1sUhPJSCcnZND6SugndnVID",
// "15tNdkKbYXoMn58NO6VbDMDWFEyIhTWEGsvgcJsHWAgD"
// }
func (cm *ChannelsManager) GetChannels() ([]byte, error) {
@@ -530,8 +530,8 @@ func (cm *ChannelsManager) SendMessage(marshalledChanId []byte,
// the largest payload that can be sent, but it will always be possible to send
// a payload of 766 bytes at minimum.
//
-// If the message ID the reply is sent to does not exist, then the other side
-// will post the message as a normal message and not a reply.
+// If the message ID that the reply is sent to does not exist, then the other
+// side will post the message as a normal message and not a reply.
// The message will auto delete validUntil after the round it is sent in,
// lasting forever if ValidForever is used.
//
@@ -839,14 +839,14 @@ type EventModel interface {
// Failed - 2
UpdateSentStatus(messageID []byte, status int64)
- //unimplemented
- //IgnoreMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID)
- //UnIgnoreMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID)
- //PinMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID, end time.Time)
- //UnPinMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID)
+ // unimplemented
+ // IgnoreMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID)
+ // UnIgnoreMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID)
+ // PinMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID, end time.Time)
+ // UnPinMessage(ChannelID *id.ID, MessageID cryptoChannel.MessageID)
}
-// toEventModel is a wrapper which wraps an existing EventModel object.
+// toEventModel is a wrapper which wraps an existing channels.EventModel object.
type toEventModel struct {
em EventModel
}
diff --git a/bindings/delivery.go b/bindings/delivery.go
index b420a58fc..a645e9412 100644
--- a/bindings/delivery.go
+++ b/bindings/delivery.go
@@ -22,9 +22,9 @@ import (
// This should be used by any type of send report's GetRoundURL method.
var dashboardBaseURL = "https://dashboard.xx.network"
-// SetDashboardURL is a function which modifies the base dashboard URL
-// that is returned as part of any send report. Internally, this is defaulted
-// to "https://dashboard.xx.network". This should only be called if the user
+// SetDashboardURL is a function which modifies the base dashboard URL that is
+// returned as part of any send report. Internally, this is defaulted to
+// "https://dashboard.xx.network". This should only be called if the user
// explicitly wants to modify the dashboard URL. This function is not
// thread-safe, and as such should only be called on setup.
//
@@ -50,7 +50,7 @@ type RoundsList struct {
Rounds []uint64
}
-// makeRoundsList converts a list of id.Round into a binding-compatable
+// makeRoundsList converts a list of id.Round into a binding-compatible
// RoundsList.
func makeRoundsList(rounds ...id.Round) RoundsList {
rl := RoundsList{make([]uint64, len(rounds))}
diff --git a/bindings/follow.go b/bindings/follow.go
index 362ace98f..503aa5e1a 100644
--- a/bindings/follow.go
+++ b/bindings/follow.go
@@ -145,8 +145,8 @@ func (c *Cmix) IsHealthy() bool {
//
// JSON Example:
// {
-// "FileTransfer{BatchBuilderThread, FilePartSendingThread#0, FilePartSendingThread#1, FilePartSendingThread#2, FilePartSendingThread#3}",
-// "MessageReception Worker 0"
+// "FileTransfer{BatchBuilderThread, FilePartSendingThread#0, FilePartSendingThread#1, FilePartSendingThread#2, FilePartSendingThread#3}",
+// "MessageReception Worker 0"
// }
func (c *Cmix) GetRunningProcesses() ([]byte, error) {
return json.Marshal(c.api.GetRunningProcesses())
diff --git a/bindings/group.go b/bindings/group.go
index 8ae6e0d0a..ddb6f12b9 100644
--- a/bindings/group.go
+++ b/bindings/group.go
@@ -322,7 +322,7 @@ func (g *Group) Serialize() []byte {
return g.g.Serialize()
}
-// DeserializeGroup converts the results of Group.Serialize() into a Group
+// DeserializeGroup converts the results of Group.Serialize into a Group
// so that its methods can be called.
func DeserializeGroup(serializedGroupData []byte) (*Group, error) {
grp, err := gs.DeserializeGroup(serializedGroupData)
--
GitLab