pry-auto_benching.rb 2.10.4 → 2.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30cdc166e3207ea2b286aac030018d099e892ec379f4a0c084683866c9492636
-  data.tar.gz: 32a7015790e4a3a0bdc4ffca022ffaed29bae8c35d500da92efe466e100fb734
+  metadata.gz: e7b0dc93c3c15661860a761a020191729d6e8f13df4d1c731b61fd1cdfc16fc0
+  data.tar.gz: 1b9f167f1539ef38333f5b8eaeb4f9917669f194cf1269032184349f785ae362
 SHA512:
-  metadata.gz: be4d9521346b19cb23d36cff445597adcd3d6b223c71ff81355eacf52b83594add0aae9244e006c24888d3f7bc044bfbf19675e28ad619c030565a9a77f06b7f
-  data.tar.gz: c98abd3ad960be617b3714742be3af0e4d5cc2a093051ee0a5bafa61ae2615332706f4fcda4e9cb82793be5f91e88d415cfe67ea1128b774c20112ea32122cc2
+  metadata.gz: ce5c18e18229ae2869e626aa8fc4365aee3e191a3ca7c83a4491ef9fa0d4c12a714ba43b1dfc6082b5f4f5e231cc420ec915e4b890f0e0a84bd91e81ac79f322
+  data.tar.gz: 43bc389c8483039f6272b9835d8cc6ad8a388682440fd2bc6ac9f33247febcdbb9120d8e70ae9b74ac48b224172dabef0e9e93b4445a0d191f4420876fd45bf7

data/CHANGELOG.md

@@ -1,12 +1,16 @@
 # CHANGELOG
 
+## v2.10.5
+
+* Doc updates
+
 ## v2.10.4
 
-* Improve documentation
+* Doc updates
 
 ## v2.10.3
 
-* Improve documentation
+* Doc updates
 
 ## v2.10.2
 
@@ -29,8 +33,8 @@
 
 ## v2.9.0
 
-* Add '--target-display' option (shorthand: '-t') to the `auto-benching` command.
-  The option is for changing where benchmark results are written to.
+* Add '--target-display' option (shorthand: '-t') to the `auto-benching` command.  
+ The option is for changing where benchmark results are written to.
 
 * Accept 'output' and 'prompt' as valid values for `Pry.config.auto_benching.target_display`,
   in addition to the already accepted values `:output` and `:prompt`.

data/README.md

@@ -4,7 +4,6 @@
 * <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>
 
@@ -14,9 +13,9 @@ pry-auto_benching.rb automates benchmarking inside the Pry REPL.
 
 ## <a id='configuration'>Configuration (optional)</a>
 
-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:
+Configuration can be skipped unless you want to change the defaults. <br>
+To change the defaults, open `~/.pryrc` in your editor of choice and change  
+one or more of the following:  
 
 ```ruby
 Pry.configure do |config|
@@ -81,7 +80,7 @@ end
 
 __1.__
 
-Display help by running `auto-benching -h`:
+Get started by reading the help menu:
 
     Usage: auto-benching [options] [enable|disable]
 
@@ -95,7 +94,8 @@ Display help by running `auto-benching -h`:
 
 __2.__
 
-The prompt is updated with benchmark results (default behavior).
+In this example, the prompt is updated with benchmark results.  
+This also happens to be the default behavior.
 
     [7] pry(main)> sleep 0.2
     => 0
@@ -107,7 +107,7 @@ The prompt is updated with benchmark results (default behavior).
 
 __3.__
 
-`_pry_.output` is updated with benchmark results.
+In this example, `_pry_.output` is updated with benchmark results.
 
     [6] pry(main)> auto-benching --target-display output
     Display changed to 'output'
@@ -123,8 +123,8 @@ __3.__
 
 __4.__
 
-Display a history of benchmark results for the current Pry session by running
-`auto-benching --past`:
+In this example, `auto-benching --past` is used to view past benchmark  
+results.
 
     [6] 0.5s (main)> auto-benching --past
     1. Net::HTTP.get_response URI.parse('https://github.com') (0.88s)
@@ -135,8 +135,7 @@ Display a history of benchmark results for the current Pry session by running
 
 __5.__
 
-Disable auto benchmarking for the current Pry session by running
-`auto-benching disable`:
+In this example, benchmarking is disabled for the current Pry session:
 
     [5] pry(main)> auto-benching disable
     pry-auto_benching.rb: stopped benchmarking.
@@ -144,36 +143,18 @@ Disable auto benchmarking for the current Pry session by running
 
 ## <a id='accuracy'>Accuracy</a>
 
-pry-auto_benching.rb can measure down to 10 milliseconds (0.01 = 10 milliseconds). <br>
-Benchmarking `sleep 0.01` shows no overhead in the results:
+pry-auto_benching.rb can measure down to 10 milliseconds (0.01 = 10ms).  
+When I benchmarked `sleep 0.01` I saw no overhead in the results:
 
     [1] pry(main)> sleep 0.01
     => 0
     [2] 0.01s (main)>
 
-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 who run before/after eval hooks as well.
-I have seen inaccuracies of 10ms (0.01) but not all the time.
+But that's not to say results can't 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 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>
-
-If you want a custom prompt to integrate with pry-auto_benching.rb, it's easy, simply use
-`pry.config.prompt_name` (by default it is equal to 'pry') somewhere in the prompt and the
-duration of a benchmark will be inserted in its place, as long as `auto_benching.target_display`
-is set to `prompt`.
-
-Example:
-
-```ruby
-Pry::Prompt.add(
-  :some_prompt,
-  'description of some_prompt',
-  %w[> *]
-) do |target, nestlevel, pry, sep|
-  "#{pry.config.prompt_name}#{sep} "
-end
-```
 
 ## <a id='install'>Install</a>
 

data/lib/pry-auto_benching/version.rb

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

metadata

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