From 0461fc2642b290c1711cc9c90299944833f220a5 Mon Sep 17 00:00:00 2001 From: Jordan LeDoux Date: Mon, 18 May 2020 01:18:32 -0700 Subject: [PATCH] test implementation of signature on simple.md --- docs/arithmetic/simple.md | 41 +++++++++++++++++++++++++++++++-------- docs/css/custom.css | 2 +- 2 files changed, 34 insertions(+), 9 deletions(-) diff --git a/docs/arithmetic/simple.md b/docs/arithmetic/simple.md index 15d8cf78..fc4ca225 100644 --- a/docs/arithmetic/simple.md +++ b/docs/arithmetic/simple.md @@ -30,7 +30,12 @@ The following methods are available for classes that implement `SimpleNumberInte If the provided `$value` matches none of these, an exception of type `Samsara\Exceptions\UsageError\IntegrityConstraint` is thrown. -###### add(mixed $num): NumberInterface +!!! signature "add(mixed $num): NumberInterface" + $num + : Accepts a mixed value that is limited to the formats detailed in the [Available Methods](#available-methods) section. + + returns + : Returns an object of the same class as the calling class if the resulting value can be represented with a `SimpleNumberInterface`. Returns an object of the `ImmutableComplexNumber` class if the resulting value has both a real and imaginary component. This function adds the current value with `$num` and returns the result. @@ -108,8 +113,13 @@ This function adds the current value with `$num` and returns the result. echo 'Circuit State: '.$newCircuitState; // Prints: 'Circuit State: 10+20i' ``` + +!!! signature "subtract(mixed $num): NumberInterface" + $num + : Accepts a mixed value that is limited to the formats detailed in the [Available Methods](#available-methods) section. -###### subtract(mixed $num): NumberInterface + returns + : Returns an object of the same class as the calling class if the resulting value can be represented with a `SimpleNumberInterface`. Returns an object of the `ImmutableComplexNumber` class if the resulting value has both a real and imaginary component. This function subtracts `$num` from the current value and returns the result. @@ -187,8 +197,13 @@ This function subtracts `$num` from the current value and returns the result. echo 'Circuit State: '.$newCircuitState; // Prints: 'Circuit State: 2+20i' ``` - -###### multiply(mixed $num): NumberInterface + +!!! signature "multiply(mixed $num): NumberInterface" + $num + : Accepts a mixed value that is limited to the formats detailed in the [Available Methods](#available-methods) section. + + returns + : Returns an object of the same class as the calling class if the resulting value can be represented with a `SimpleNumberInterface`. Returns an object of the `ImmutableComplexNumber` class if the resulting value has both a real and imaginary component. This function multiplies `$num` with the current value and returns the result. @@ -266,8 +281,13 @@ This function multiplies `$num` with the current value and returns the result. echo 'Circuit State: '.$newCircuitState; // Prints: 'Circuit State: 24+80i' ``` - -###### divide(mixed $num, ?int $scale = null): NumberInterface + +!!! signature "divide(mixed $num, ?int $scale = null): NumberInterface" + $num + : Accepts a mixed value that is limited to the formats detailed in the [Available Methods](#available-methods) section. + + returns + : Returns an object of the same class as the calling class if the resulting value can be represented with a `SimpleNumberInterface`. Returns an object of the `ImmutableComplexNumber` class if the resulting value has both a real and imaginary component. This function divides `$num` with the current value and returns the result. @@ -350,8 +370,13 @@ This function divides `$num` with the current value and returns the result. echo 'Circuit State: '.$newCircuitState; // Prints: 'Circuit State: 1.5+5i' ``` - -###### pow(mixed $num): NumberInterface + +!!! signature "pow(mixed $num): NumberInterface" + $num + : Accepts a mixed value that is limited to the formats detailed in the [Available Methods](#available-methods) section. + + returns + : Returns an object of the same class as the calling class if the resulting value can be represented with a `SimpleNumberInterface`. Returns an object of the `ImmutableComplexNumber` class if the resulting value has both a real and imaginary component. This function raises the current value to the power of `$num` and returns the result. diff --git a/docs/css/custom.css b/docs/css/custom.css index 4c22a035..a106d22e 100644 --- a/docs/css/custom.css +++ b/docs/css/custom.css @@ -176,7 +176,7 @@ svg.fa-signature path { background: inherit; font-family: 'Source Code Pro'; font-weight: 500; - font-size: 12px; + font-size: 16px; line-height: 16px; border-bottom: 1px solid #000; padding-bottom: 5px;