pry-auto_benching.rb 2.10.2 → 2.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b26198453a88a7fb67cb8448d8caec3994fb5e977c372d728a0ddb33cc42842
-  data.tar.gz: 0b027e7885209b80106511767514a294a854c7511f425cb860977a4b81f40d30
+  metadata.gz: 696bf09af2e1154b97fc3d5fef3008a88c4ef6c9f4f196a304386b0545eccec6
+  data.tar.gz: e0dcd556fc9442e11816ba6dc170b2285f32cc222ed1ccc404653d54918c9cfc
 SHA512:
-  metadata.gz: b0faf973255c58f7e4d1bf3f240a5a02db952dab641c79ada4851aff6109a216ece1eb1267d54c07e6fb53e0a39ed54c48f0ed6eb4fad0556b853bb6a0871a3e
-  data.tar.gz: 5eaa3e229fef6b3a3f8114ed60332cf458e4d3913232e652ac0b32f4c9ecdc1bcb23e8c82f7ec422730771179978fe98c8dc821b6a39a3333796935707c5ab70
+  metadata.gz: a85843a8588f075033a94193f279bd7a78a1cf8b0f6302f75d213fdf56ab7e7390c220829fd5456555610299e0fc42af66f7eb4420aed829cc347ce1e1249257
+  data.tar.gz: e1a184b7d9bc7425584747f43e689557cd47bb9faa6e65d6ab23c503d24dd741625181a6299462cf0d37f5b40d320bf9ad76a12ce53ca421d474c374f9bd0696

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v2.10.3
+
+* Improve documentation
+
 ## v2.10.2
 
 * Prevent an exception from being raised when running `auto-benching --version`.

data/README.md

@@ -1,11 +1,21 @@
 # pry-auto_benching.rb
 
-pry-auto_benching.rb automates benchmarking in Pry.
+* <a href="#introduction">Introduction</a>
+* <a href='#configuration'>Configuration (optional)</a>
+* <a href='#examples'>Examples</a>
+* <a href='#accuracy'>Accuracy</a>
+* <a href='#install'>Install</a>
+* <a href='#license'>License</a>
 
-## Configuration (optional)
+## <a id='introduction'>Introduction</a>
 
-Configuration isn't required unless you want to change a default.<br>
-To change a default, open `~/.pryrc` and add code along the lines of:
+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 options:
 
 ```ruby
 Pry.configure do |config|
@@ -50,11 +60,11 @@ Pry.configure do |config|
 end
 ```
 
-## Examples
+## <a id='examples'>Examples</a>
 
 __1.__
 
-Show help by running `auto-benching -h`:
+Display help by running `auto-benching -h`:
 
     Usage: auto-benching [options] [enable|disable]
 
@@ -68,8 +78,7 @@ Show help by running `auto-benching -h`:
 
 __2.__
 
-An example showing the prompt being updated with benchmark results. <br>
-This is the default.
+The prompt is updated with benchmark results (default behavior).
 
     [7] pry(main)> sleep 0.2
     => 0
@@ -81,7 +90,7 @@ This is the default.
 
 __3.__
 
-An example showing `:output` set as the `target_display`.
+`_pry_.output` is updated with benchmark results.
 
     [6] pry(main)> auto-benching --target-display output
     Display changed to 'output'
@@ -97,7 +106,7 @@ An example showing `:output` set as the `target_display`.
 
 __4.__
 
-Displaying a history of benchmark results for the current Pry session using
+Display a history of benchmark results for the current Pry session with
 `auto-benching --past`:
 
     [6] 0.5s (main)> auto-benching --past
@@ -116,7 +125,7 @@ Disable auto benchmarking for the current Pry session by running
     pry-auto_benching.rb: stopped benchmarking.
     [6] pry(main)>
 
-## Accuracy
+## <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:
@@ -134,12 +143,12 @@ 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.
 
-## Integration with custom prompts
+## <a id='custom-prompts'>Custom prompts</a>
 
-If you want a custom prompt to integrate with pry-auto_benching.rb, it's easy, just use
+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`.
+is set to `prompt`.
 
 Example:
 
@@ -153,10 +162,10 @@ Pry::Prompt.add(
 end
 ```
 
-## Install
+## <a id='install'>Install</a>
 
     gem install pry-auto_benching.rb
 
-## License
+## <a id='license'>License</a>
 
-[MIT](./LICENSE.txt).
+This project uses the MIT license, see [LICENSE.txt](LICENSE.txt) for details.

data/lib/pry-auto_benching/version.rb

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

data/pry-auto_benching.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.version = Pry::AutoBenching::VERSION
   spec.authors = ["Robert Gleeson"]
   spec.email = "trebor.g@protonmail.com"
-  spec.summary = "Automates benchmarking in Pry"
+  spec.summary = "Automates benchmarking inside the Pry REPL"
   spec.description = spec.summary
   spec.homepage = "https://github.com/r-obert/pry-auto_benching.rb"
   spec.licenses = ["MIT"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-auto_benching.rb
 version: !ruby/object:Gem::Version
-  version: 2.10.2
+  version: 2.10.3
 platform: ruby
 authors:
 - Robert Gleeson
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
-description: Automates benchmarking in Pry
+description: Automates benchmarking inside the Pry REPL
 email: trebor.g@protonmail.com
 executables: []
 extensions: []
@@ -60,5 +60,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Automates benchmarking in Pry
+summary: Automates benchmarking inside the Pry REPL
 test_files: []