Start documentation with method name.

Replaces klauspost#92
dssysolyatin · Feb 15, 2019 · 09979cd · 09979cd
1 parent 2b210cf
commit 09979cd
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/matrix.go b/matrix.go
@@ -151,7 +151,7 @@ func (m matrix) SameSize(n matrix) error {
 	return nil
 }
 
-// Returns a part of this matrix. Data is copied.
+// SubMatrix returns a part of this matrix. Data is copied.
 func (m matrix) SubMatrix(rmin, cmin, rmax, cmax int) (matrix, error) {
 	result, err := newMatrix(rmax-rmin, cmax-cmin)
 	if err != nil {

diff --git a/reedsolomon.go b/reedsolomon.go
@@ -23,7 +23,7 @@ import (
 
 // Encoder is an interface to encode Reed-Salomon parity sets for your data.
 type Encoder interface {
-	// Encodes parity for a set of data shards.
+	// Encode parity for a set of data shards.
 	// Input is 'shards' containing data shards followed by parity shards.
 	// The number of shards must match the number given to New().
 	// Each shard is a byte array, and they must all be the same size.

diff --git a/streaming.go b/streaming.go
@@ -27,7 +27,7 @@ import (
 // For usage examples, see "stream-encoder.go" and "streamdecoder.go" in the examples
 // folder.
 type StreamEncoder interface {
-	// Encodes parity shards for a set of data shards.
+	// Encode parity shards for a set of data shards.
 	//
 	// Input is 'shards' containing readers for data shards followed by parity shards
 	// io.Writer.