aboutsummaryrefslogtreecommitdiffstats
path: root/python
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2021-06-21 17:04:55 +0200
committerMartin Czygan <martin.czygan@gmail.com>2021-06-21 17:04:55 +0200
commitf8521ff46371e5ba98681228b558954f80a8ff71 (patch)
tree177cdcd9759a27bc190a9800dae8413890a7af80 /python
parenta39e266ddeb9d11b9f23f50a0124c56e3414563c (diff)
downloadrefcat-f8521ff46371e5ba98681228b558954f80a8ff71.tar.gz
refcat-f8521ff46371e5ba98681228b558954f80a8ff71.zip
update docs
Diffstat (limited to 'python')
-rw-r--r--python/refcat/tasks.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/python/refcat/tasks.py b/python/refcat/tasks.py
index 7aecd08..bf479f0 100644
--- a/python/refcat/tasks.py
+++ b/python/refcat/tasks.py
@@ -16,6 +16,14 @@ Set of luigi tasks to derive a citation graph.
Commands: ls, ll, deps, tasks, files, config, cat, completion
+ To run a task, e.g. URLList:
+
+ $ refcat.pyz URLList
+
+ To run a subcommand, e.g. to show task dependencies:
+
+ $ refcat.pyz deps URLList
+
To install completion run:
$ source <(refcat.pyz completion)
@@ -1279,6 +1287,9 @@ class BrefCombined(Refcat):
This is basically a reduce step, where we group by work id (since the raw
refs were already sorted by work id).
+
+ Data point: version 2021-05-06 results in 1,323,614,061 docs (77G
+ compressed; about 285G when indexed in ES7).
"""
def requires(self):
return {