Skip to content

Commit 3de081e

Browse files
committed
fix doc
1 parent 38189b0 commit 3de081e

File tree

6 files changed

+8
-228
lines changed

6 files changed

+8
-228
lines changed

counters/atomic_counter.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Package chotki provides AtomicCounter - a high-performance atomic counter implementation
1+
// Provides AtomicCounter - a high-performance atomic counter implementation
22
// for distributed systems with CRDT semantics.
33
//
44
// # AtomicCounter Architecture
@@ -60,7 +60,6 @@
6060
// // With cache: may still return 5 until cache expires
6161
// // Without cache: immediately returns 15 (5 + 10)
6262
// ```
63-
6463
package counters
6564

6665
import (

docs/rfc/rfc-0001-index-management.md

Lines changed: 0 additions & 219 deletions
This file was deleted.

network/net.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Package network provides a high-performance TCP/TLS server and client implementation
1+
// Provides a high-performance TCP/TLS server and client implementation
22
// for real-time asynchronous communication. This package is designed for continuous
33
// bidirectional message streaming with high throughput and low latency, unlike
44
// traditional request-response patterns (like HTTP).

protocol/tlv.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
// Protocol format is based on ToyTLV (MIT licence) written by Victor Grishchenko in 2024
2-
// Original project: https://github.com/learn-decentralized-systems/toytlv
3-
41
/*
5-
Package protocol implements a compact TLV (Type-Length-Value) encoding format optimized for efficiency.
2+
Implements a compact TLV (Type-Length-Value) encoding format optimized for efficiency.
3+
4+
Protocol format is based on ToyTLV (MIT licence) written by Victor Grishchenko in 2024
5+
Original project: https://github.com/learn-decentralized-systems/toytlv
66
77
# TLV Record Format
88

rdx/_doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@
271271
// Object/fields ids are serialized as tiny `ZipUint64Pair`s.
272272
// Revisions are serialized as tiny `ZipIntUint64Pair`s.
273273

274+
//
274275
// [x]: https://en.wikipedia.org/wiki/Causal_consistency
275276
// [v]: https://en.wikipedia.org/wiki/Version_vector
276277
// [r]: https://www.educative.io/answers/how-are-vector-clocks-used-in-dynamo
@@ -279,5 +280,4 @@
279280
// [g]: https://protobuf.dev/programming-guides/encoding/
280281
// [b]: https://en.wikipedia.org/wiki/LEB128
281282
// [m]: https://en.wikipedia.org/wiki/Merge_sort
282-
283283
package rdx

replication/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Package replication implements the Chotki distributed synchronization protocol.
2+
Implements the Chotki distributed synchronization protocol.
33
44
# Protocol Overview
55

0 commit comments

Comments
 (0)