Decoding bug fixes #42

pkgs/erasure/doc.go

@@ -13,37 +13,36 @@
 //
 // Encoding data may be performed in 3 steps.
 //
-//  1. Create a validated set of encoder parameters
+//  1. Create a parse set of encoder parameters
 //  2. Create a new encoder
 //  3. Encode data
 //
 // Decoding data is also performed in 3 steps.
 //
-//  1. Create a validated set of encoder parameters
+//  1. Create a parse set of encoder parameters for validation
 //  2. Create a new encoder
 //  3. Decode data
 //
 // Encoder parameters contain four configurable elements:
-//  ValidateParams(k, m, w, technique int) (EncoderParams, error)
+//  ParseEncoderParams(k, m, technique int) (EncoderParams, error)
 //  k - Number of rows in matrix
 //  m - Number of colums in matrix
-//  w - Word size, typically 8 or aligned by 8.
 //  technique - Matrix type, can be either CAUCHY (recommended) or VANDERMONDE
-//  constraints: k + m < 256
+//  constraints: k + m < Galois Field (2^8)
 //
 // Example
 //
 //
 // Creating and using an encoder
 //  var bytes []byte
-//  params := erasure.ValidateParams(10,5, 8, erasure.CAUCHY)
+//  params := erasure.ParseEncoderParams(10, 5, erasure.CAUCHY)
 //  encoder := erasure.NewEncoder(params)
 //  encodedData, length := encoder.Encode(bytes)
 //
 // Creating and using a decoder
 //  var encodedData [][]byte
 //  var length int
-//  params := erasure.ValidateParams(10,5, 8, erasure.CAUCHY)
+//  params := erasure.ParseEncoderParams(10, 5, erasure.CAUCHY)
 //  encoder := erasure.NewEncoder(params)
 //  originalData, err := encoder.Decode(encodedData, length)
 package erasure