Update benchmark docstrings with notes about generating data

grantjenks · grantjenks · commit 97b960d921da · 2017-12-14T16:25:44.000-08:00
diff --git a/tests/benchmark_core.py b/tests/benchmark_core.py
@@ -1,4 +1,10 @@
-"Benchmark diskcache.Core."
+"""Benchmark diskcache.Cache
+
+$ export PYTHONPATH=/Users/grantj/repos/python-diskcache
+$ python tests/benchmark_core.py -p 1 > tests/timings_core_p1.txt
+$ python tests/benchmark_core.py -p 8 > tests/timings_core_p8.txt
+
+"""
 
 from __future__ import print_function
 
diff --git a/tests/benchmark_djangocache.py b/tests/benchmark_djangocache.py
@@ -1,4 +1,10 @@
-"Benchmark diskcache.DjangoCache"
+"""Benchmark diskcache.DjangoCache
+
+$ export PYTHONPATH=/Users/grantj/repos/python-diskcache
+$ python tests/benchmark_djangocache.py > tests/timings_djangocache.txt
+
+
+"""
 
 from __future__ import print_function
 
diff --git a/tests/plot.py b/tests/plot.py
@@ -1,4 +1,9 @@
-"Plot benchmark docs."
+"""Plot Benchmarks for docs
+
+$ export PYTHONPATH=/Users/grantj/repos/python-diskcache
+$ python tests/plot.py --show tests/timings_core_p1.txt
+
+"""
 
 import argparse
 import collections as co

-Original file line number
+Diff line change
@@ @@ -1,4 +1,9 @@ @@
 -"Plot benchmark docs."
 +"""Plot Benchmarks for docs
++
 +$ export PYTHONPATH=/Users/grantj/repos/python-diskcache
 +$ python tests/plot.py --show tests/timings_core_p1.txt
++
 +"""
 importargparse
 importcollectionsasco