pry-auto_benching.rb 2.10.3 → 2.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 696bf09af2e1154b97fc3d5fef3008a88c4ef6c9f4f196a304386b0545eccec6
-  data.tar.gz: e0dcd556fc9442e11816ba6dc170b2285f32cc222ed1ccc404653d54918c9cfc
+  metadata.gz: 30cdc166e3207ea2b286aac030018d099e892ec379f4a0c084683866c9492636
+  data.tar.gz: 32a7015790e4a3a0bdc4ffca022ffaed29bae8c35d500da92efe466e100fb734
 SHA512:
-  metadata.gz: a85843a8588f075033a94193f279bd7a78a1cf8b0f6302f75d213fdf56ab7e7390c220829fd5456555610299e0fc42af66f7eb4420aed829cc347ce1e1249257
-  data.tar.gz: e1a184b7d9bc7425584747f43e689557cd47bb9faa6e65d6ab23c503d24dd741625181a6299462cf0d37f5b40d320bf9ad76a12ce53ca421d474c374f9bd0696
+  metadata.gz: be4d9521346b19cb23d36cff445597adcd3d6b223c71ff81355eacf52b83594add0aae9244e006c24888d3f7bc044bfbf19675e28ad619c030565a9a77f06b7f
+  data.tar.gz: c98abd3ad960be617b3714742be3af0e4d5cc2a093051ee0a5bafa61ae2615332706f4fcda4e9cb82793be5f91e88d415cfe67ea1128b774c20112ea32122cc2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v2.10.4
+
+* Improve documentation
+
 ## v2.10.3
 
 * Improve documentation

data/README.md

@@ -4,6 +4,7 @@
 * <a href='#configuration'>Configuration (optional)</a>
 * <a href='#examples'>Examples</a>
 * <a href='#accuracy'>Accuracy</a>
+* <a href='#custom-prompts'>Custom prompts</a>
 * <a href='#install'>Install</a>
 * <a href='#license'>License</a>
 
@@ -15,23 +16,32 @@ pry-auto_benching.rb automates benchmarking inside the Pry REPL.
 
 Configuration isn't required unless you want to change a default. <br>
 To change the defaults, open `~/.pryrc` and change one or more of the
-following options:
+following:
 
 ```ruby
 Pry.configure do |config|
-  # Start benchmarking as soon as Pry starts? default is true.
+  #
+  # Start benchmarking as soon as Pry starts?
+  # The default is true.
+  #
   config.auto_benching.enabled = false
 
+  #
   # The max number of previous benchmark results to store in memory,
   # for use by `auto-benching --past`. The default is 70.
+  #
   config.auto_benching.max_history_size = 120
 
+  #
   # The type of clock to use, default is Process::CLOCK_MONOTONIC.
   # See https://www.rubydoc.info/stdlib/core/Process:clock_gettime
+  #
   config.auto_benching.clock_type = Process::CLOCK_REALTIME
 
+  #
   # Configure where benchmark results will be displayed.
-  # Valid options are:
+  # Accepted options are:
+  #
   # * prompt
   #   The default, results are written to the prompt.
   #
@@ -39,21 +49,28 @@ Pry.configure do |config|
   #   Results are written directly to `_pry_.output`
   #
   # * none
-  #   Results are not displayed but are still recorded and can be viewed on
-  #   demand by running 'auto-benching --past'.
+  #   Results are not displayed but are still recorded and can be
+  #   viewed on demand by running 'auto-benching --past'.
+  #
   config.auto_benching.target_display =  ':prompt | :output | :none'
 
+  #
   # Define a Proc that decides whether or not to record or display benchmark
   # results. The default condition is 'duration >= 0.01'.
+  #
   config.auto_benching.display_duration_if = ->(pry, duration) { duration >= 0.02 }
 
+  #
   # The color to use for benchmark results when `target_display` is :prompt.
   # The default is :green.
+  #
   config.auto_benching.prompt_color = :red
 
+  #
   # A lambda that returns a string for display on `_pry_.output` (usually $stdout).
   # This lambda is used when `target_display` is equal to `:output`.
   # Default is: "pry-auto_benching.rb: %.2fs".
+  #
   config.auto_benching.output_string = ->(pry, duration) {
     sprintf("elapsed time: %.2fs", duration)
   }
@@ -106,7 +123,7 @@ __3.__
 
 __4.__
 
-Display a history of benchmark results for the current Pry session with
+Display a history of benchmark results for the current Pry session by running
 `auto-benching --past`:
 
     [6] 0.5s (main)> auto-benching --past
@@ -134,14 +151,10 @@ Benchmarking `sleep 0.01` shows no overhead in the results:
     => 0
     [2] 0.01s (main)>
 
-But it is possible results can be reported inaccurately since the measurement
+But it is possible results can be reported inaccurately since the benchmark
 includes a **very** small number of method calls to Pry internals, and it could
-include time spent by other Pry plugins as well. I have seen inaccuracies of
-10ms (0.01) but not all the time.
-
-The overhead could be considered negligible, although other Pry plugins running
-before/after eval hooks and spending a lot of time doing that could skew results
-more than is expected.
+include time spent by other Pry plugins who run before/after eval hooks as well.
+I have seen inaccuracies of 10ms (0.01) but not all the time.
 
 ## <a id='custom-prompts'>Custom prompts</a>
 

data/lib/pry-auto_benching/version.rb

@@ -1,5 +1,5 @@
 class Pry
   module AutoBenching
-    VERSION = "2.10.3"
+    VERSION = "2.10.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-auto_benching.rb
 version: !ruby/object:Gem::Version
-  version: 2.10.3
+  version: 2.10.4
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry