aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2021-06-01 19:49:17 +0200
committerMartin Czygan <martin.czygan@gmail.com>2021-06-01 19:49:17 +0200
commitdad3a75961e1bca6c17cb858e32e3806a37a48f7 (patch)
tree124759b5eafb5a7b442914120c5e2670dba11938
parent6f34cf584472ad2f075219fa88d7d90c3e1cdc4c (diff)
downloadrefcat-dad3a75961e1bca6c17cb858e32e3806a37a48f7.tar.gz
refcat-dad3a75961e1bca6c17cb858e32e3806a37a48f7.zip
update docs
-rw-r--r--skate/cmd/skate-resolve-journal-name/main.go9
1 files changed, 5 insertions, 4 deletions
diff --git a/skate/cmd/skate-resolve-journal-name/main.go b/skate/cmd/skate-resolve-journal-name/main.go
index d98f166..494b236 100644
--- a/skate/cmd/skate-resolve-journal-name/main.go
+++ b/skate/cmd/skate-resolve-journal-name/main.go
@@ -1,7 +1,8 @@
-// skate-resolve-journal-name works on TSV where one column (-f) is a release
-// schema. 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.
+// 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
+// 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).