aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2021-06-09 23:01:42 +0200
committerMartin Czygan <martin.czygan@gmail.com>2021-06-09 23:01:42 +0200
commitb85f3cab82f1bcc757021daadfc65a68ce834f6d (patch)
tree7dece74acad6ec58320f642dc3a0ff101a536cf0
parent8434e5c0dc22ade7fed8d7b447a783178d95d551 (diff)
downloadrefcat-b85f3cab82f1bcc757021daadfc65a68ce834f6d.tar.gz
refcat-b85f3cab82f1bcc757021daadfc65a68ce834f6d.zip
update docs
-rw-r--r--skate/cmd/skate-resolve-journal-name/main.go5
1 files changed, 3 insertions, 2 deletions
diff --git a/skate/cmd/skate-resolve-journal-name/main.go b/skate/cmd/skate-resolve-journal-name/main.go
index 52c3394..0bd4866 100644
--- a/skate/cmd/skate-resolve-journal-name/main.go
+++ b/skate/cmd/skate-resolve-journal-name/main.go
@@ -1,11 +1,12 @@
// skate-resolve-journal-name works on TSV where one column (-f, 1-indexed) is
-// a release schema. It will inspect the container name and will resolve
+// a release schema (json). It will inspect the container name and will resolve
// journal name abbreviations and will augment the release document with data
// in extra containing the resolved name (e.g. in
// extra.skate.resolved_container_name).
//
// The abbreviation file format currently is a JSONL format, each document
-// containing a "name" and "abbrev" (optional).
+// containing a "name" (required) and "abbrev" (optional), e.g. like:
+// https://git.archive.org/martin/cgraph/-/raw/master/extra/abbrev/jabbrev.json.
package main
import (