aboutsummaryrefslogtreecommitdiffstats
path: root/identity
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2022-03-10 16:27:22 +0100
committerMichael Muré <batolettre@gmail.com>2022-03-10 16:30:27 +0100
commitb11679bc80b115c61a5cdee8ff8b5f8f1f69533d (patch)
tree956495036e383caab11006239e31e591436a33cd /identity
parentdf55cc49a85eaf3a2d3c2ceb1fbcccac19fa6eb8 (diff)
downloadgit-bug-b11679bc80b115c61a5cdee8ff8b5f8f1f69533d.tar.gz
Fix a bunch of comments and documentations
Diffstat (limited to 'identity')
-rw-r--r--identity/identity.go8
-rw-r--r--identity/interface.go2
2 files changed, 5 insertions, 5 deletions
diff --git a/identity/identity.go b/identity/identity.go
index ad5f1efd..0a7642af 100644
--- a/identity/identity.go
+++ b/identity/identity.go
@@ -381,9 +381,9 @@ func (i *Identity) NeedCommit() bool {
//
// To make sure that an Identity history can't be altered, a strict fast-forward
// only policy is applied here. As an Identity should be tied to a single user, this
-// should work in practice but it does leave a possibility that a user would edit his
+// should work in practice, but it does leave a possibility that a user would edit his
// Identity from two different repo concurrently and push the changes in a non-centralized
-// network of repositories. In this case, it would result in some of the repo accepting one
+// network of repositories. In this case, it would result in some repo accepting one
// version and some other accepting another, preventing the network in general to converge
// to the same result. This would create a sort of partition of the network, and manual
// cleaning would be required.
@@ -396,9 +396,9 @@ func (i *Identity) NeedCommit() bool {
// However, this approach leave the possibility, in the case of a compromised crypto keys,
// of forging a new version with a bogus Lamport time to be inserted before a legit version,
// invalidating the correct version and hijacking the Identity. There would only be a short
-// period of time where this would be possible (before the network converge) but I'm not
+// period of time when this would be possible (before the network converge) but I'm not
// confident enough to implement that. I choose the strict fast-forward only approach,
-// despite it's potential problem with two different version as mentioned above.
+// despite its potential problem with two different version as mentioned above.
func (i *Identity) Merge(repo repository.Repo, other *Identity) (bool, error) {
if i.Id() != other.Id() {
return false, errors.New("merging unrelated identities is not supported")
diff --git a/identity/interface.go b/identity/interface.go
index 5b14295b..c6e22e00 100644
--- a/identity/interface.go
+++ b/identity/interface.go
@@ -57,6 +57,6 @@ type Interface interface {
// Validate check if the Identity data is valid
Validate() error
- // Indicate that the in-memory state changed and need to be commit in the repository
+ // NeedCommit indicate that the in-memory state changed and need to be committed in the repository
NeedCommit() bool
}