Skip to content
Snippets Groups Projects
Commit 70c6a360 authored by Jono Wenger's avatar Jono Wenger
Browse files

Fix bindings comments

parent 3bce7b64
No related branches found
No related tags found
3 merge requests!510Release,!419rewrote the health tracker to both consider if there are waiting rounds and...,!340Project/channels
......@@ -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.
//
......@@ -846,7 +846,7 @@ type EventModel interface {
// 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
}
......
......@@ -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))}
......
......@@ -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)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment