README.adoc in marameters-0.10.0 vs README.adoc in marameters-1.0.0
- old
+ new
@@ -42,11 +42,11 @@
gem "marameters"
----
== Usage
-At a high level, you can use `Marameters` as a single object interface for accessing all capabilities provided by this gem. Here's an overview:
+At a high level, you can use `Marameters` as a single Object API for accessing all capabilities provided by this gem. Here's an overview:
[source,ruby]
----
# Setup
def demo(one, two = 2, three: 3) = puts "One: #{one}, Two: #{two}, Three: #{three}"
@@ -61,11 +61,11 @@
# Marameters::Probe wrapper
Marameters.of self, :demo # []
-probe = Marameters.probe parameters
+probe = Marameters.for parameters
probe.to_a # [[:req, :one], [:opt, :two], [:key, :three]]
probe.positionals # [:one, :two]
probe.keywords # [:three]
probe.block # nil
@@ -77,10 +77,10 @@
Read on to learn more about the details on how each of these methods work and the objects they wrap.
=== Probe
-The probe allows you to analyze a method's parameters. To understand how, consider the following demonstration class:
+The probe allows you to analyze a method's parameters. To understand how, consider the following:
[source,ruby]
----
class Demo
def initialize logger: Logger.new(STDOUT)