summaryrefslogtreecommitdiff
path: root/pkg/prob
diff options
context:
space:
mode:
authorNick White <git@njw.name>2020-04-14 11:56:56 +0100
committerNick White <git@njw.name>2020-04-14 11:56:56 +0100
commit848f961c277525ebba3ab08fadc116970bcfed24 (patch)
tree00a6883568c29ac34d56f958f7d3479e372d8c31 /pkg/prob
parentd9612a98ab66409858e07a9a430d40beac1b17b8 (diff)
Add godoc documentation
Diffstat (limited to 'pkg/prob')
-rw-r--r--pkg/prob/prob.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/pkg/prob/prob.go b/pkg/prob/prob.go
index 7a6979a..67baa03 100644
--- a/pkg/prob/prob.go
+++ b/pkg/prob/prob.go
@@ -2,6 +2,7 @@
// Use of this source code is governed by the GPLv3
// license that can be found in the LICENSE file.
+// prob processes .prob files generated by ocropus
package prob
import (
@@ -41,7 +42,7 @@ func getLineAvg(f string) (float64, error) {
return avg, nil
}
-// Note this only processes one line at a time
+// GetLineDetails parses a .prob and corresponding .txt file
func GetLineDetails(probfn string) (line.Details, error) {
var l line.Detail
lines := make(line.Details, 0)